diff --git a/.gitattributes b/.gitattributes index 730efc30f..e91a4bad3 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,11 +1,6 @@ -# Path-based git attributes -# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html - -# Ignore all test and documentation with "export-ignore". -/docs export-ignore -/tests export-ignore -/lib/Imagine/Test export-ignore -/.gitattributes export-ignore -/.gitignore export-ignore -/.travis.yml export-ignore -/phpunit.xml.dist export-ignore +/.* export-ignore +/docs export-ignore +/src/resources/Adobe/Profile[[:space:]]Information.md export-ignore +/tests export-ignore +/phpunit.xml.dist export-ignore +/MAINTAINERS.md export-ignore diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..eb2de7eba --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,34 @@ +### Issue description + +... + + +### What version of Imagine are you using? + + + + +### What's the PHP version you are using? + + + + +### What's the imaging library you are using [gd/imagick/gmagick/any]? + +... + + +### What's the imaging library configuration + + + + +### Minimal PHP code to reproduce the error: + +```php + +// Please write the PHP code that shows the issue +// Use only code of the Imagine library (no 3rd party PHP libraries) +// If you load an image, please provide it too so that we can replicate your issue + +``` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..514612250 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ + diff --git a/.github/workflows/coding-style.yml b/.github/workflows/coding-style.yml new file mode 100644 index 000000000..1e004bd9c --- /dev/null +++ b/.github/workflows/coding-style.yml @@ -0,0 +1,30 @@ +name: Coding Style + +on: + push: + paths: + - .github/workflows/coding-style.yml + - "**.php" + pull_request: + paths: + - .github/workflows/coding-style.yml + - "**.php" + +jobs: + php: + name: PHP Coding Style + runs-on: ubuntu-latest + steps: + + - name: Checkout + uses: actions/checkout@v2 + + - name: Install PHP + uses: shivammathur/setup-php@v2 + with: + php-version: "7.4" + coverage: none + tools: php-cs-fixer:v3 + + - name: Run php-cs-fixer + run: php-cs-fixer fix --path-mode=intersection --config=.php-cs-fixer.dist.php --dry-run --using-cache=no --diff --ansi --no-interaction . diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml new file mode 100644 index 000000000..50100fb74 --- /dev/null +++ b/.github/workflows/phpunit.yml @@ -0,0 +1,136 @@ +name: PHPUnit + +on: + pull_request: + paths: + - .github/workflows/phpunit.yml + - "src/**" + - "tests/**" + - composer.json + - phpunit.xml.dist + push: + paths: + - .github/workflows/phpunit.yml + - "src/**" + - "tests/**" + - composer.json + - phpunit.xml.dist + +env: + ALL_DRIVERS: "gd gmagick imagick" + IMAGINE_TEST_WEBSERVERURL: http://localhost:8013 + # Uncomment the following line to save test files as artifacts + #IMAGINE_TEST_KEEP_TEMPFILES: yes + +jobs: + + windows: + name: PHP ${{ matrix.php-version }} - ${{ matrix.extensions }} (Windows) + runs-on: windows-latest + strategy: + fail-fast: false + matrix: + php-version: + - "7.4" + - "8.1" + extensions: + - gd,imagick + steps: + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php-version }} + extensions: exif,${{ matrix.extensions }} + tools: composer:v2 + coverage: none + - name: Inspect environment + id: inspect + run: | + $EXCLUDED_GROUPS='always-skipped' + foreach ($DRIVER in $Env:ALL_DRIVERS.split()) { + Write-Output "### CHECKING $DRIVER" + php --ri $DRIVER + if ($LASTEXITCODE -ne 0) { + $EXCLUDED_GROUPS="$EXCLUDED_GROUPS,$DRIVER" + $Global:LASTEXITCODE = 0 + } + Write-Output '' + } + Write-Output "::set-output name=excluded-groups::$EXCLUDED_GROUPS" + + - name: Checkout + uses: actions/checkout@v2 + - name: Install composer dependencies + run: composer update --ansi --no-interaction + - name: Start test web server + uses: Eun/http-server-action@v1 + with: + directory: ${{ github.workspace }}/tests + port: 8013 + - name: PHPUnit + run: composer run test --ansi --no-interaction -- --exclude-group "${{ steps.inspect.outputs.excluded-groups }}" + - name: Save tests temporary files + if: always() && env.IMAGINE_TEST_KEEP_TEMPFILES == 'yes' + uses: actions/upload-artifact@v4 + with: + name: windows-${{ matrix.php-version }}-${{ matrix.extensions }} + path: tests/tmp/ + retention-days: 1 + + docker: + name: PHP ${{ matrix.php-version }} - ${{ matrix.image-suffix }} (Docker) + runs-on: ubuntu-22.04 + strategy: + fail-fast: false + matrix: + php-version: + - "7.1" + - "7.2" + - "7.3" + - "7.4" + - "8.0" + - "8.1" + - "8.2" + - "8.3" + - "8.4" + image-suffix: + - gd-gmagick + - gd-imagick + container: ghcr.io/php-imagine/test:${{ matrix.php-version }}-${{ matrix.image-suffix }} + steps: + - name: Inspect environment + id: inspect + run: | + EXCLUDED_GROUPS=always-skipped + for DRIVER in $ALL_DRIVERS; do + echo "### CHECKING $DRIVER" + if ! php --ri $DRIVER; then + EXCLUDED_GROUPS="$EXCLUDED_GROUPS,$DRIVER" + fi + echo '' + done + echo "::set-output name=excluded-groups::$EXCLUDED_GROUPS" + - name: Enable opcache + if: matrix.php-version == '7.3' + run: | + docker-php-ext-enable opcache + echo 'opcache.enable_cli=1' >> "$PHP_INI_DIR/conf.d/docker-php-ext-opcache.ini" + - name: Checkout + uses: actions/checkout@v2 + - name: Install composer dependencies + run: composer update --ansi --no-interaction + - name: Start test web server + id: start-webserver + run: | + cd ./tests + php -n -S 0.0.0.0:8013 & + cd - >/dev/null + - name: PHPUnit + run: composer run test --ansi --no-interaction -- --exclude-group "${{ steps.inspect.outputs.excluded-groups }}" + - name: Save tests temporary files + if: always() && env.IMAGINE_TEST_KEEP_TEMPFILES == 'yes' + uses: actions/upload-artifact@v4 + with: + name: docker-${{ matrix.php-version }}-${{ matrix.image-suffix }} + path: tests/tmp/ + retention-days: 1 diff --git a/.gitignore b/.gitignore index ede0fd0c6..ff26ef7b7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,12 @@ -tests/Imagine/Fixtures/results/in_out -!tests/Imagine/Fixtures/results/in_out/.placeholder -docs/_build -Imagine-*.tgz -imagine-*.phar -composer.lock -composer.phar -vendor/ -bin/ +/bin/ +/docs/_build/cache/ +/docs/_build/doctrees/ +/docs/_build/html/ +/docs/_build/vendor/ +/docs/_build/composer.lock +/tests/tmp/ +/vendor/ +/composer.lock +/.php-cs-fixer.cache +/.php-cs-fixer.php +/.phpunit.result.cache diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 000000000..77f455b86 --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,240 @@ +setRiskyAllowed(true) + ->setRules(array( + // PHP arrays should be declared using the configured syntax. + 'array_syntax' => array('syntax' => 'long'), + // Binary operators should be surrounded by space as configured. + 'binary_operator_spaces' => array('default' => 'single_space'), + // There MUST be one blank line after the namespace declaration. + 'blank_line_after_namespace' => true, + // Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line. + 'blank_line_after_opening_tag' => true, + // An empty line feed must precede any configured statement. + 'blank_line_before_statement' => array('statements' => array('return')), + // The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented. + 'braces' => array('allow_single_line_closure' => true), + // A single space or none should be between cast and variable. + 'cast_spaces' => true, + // Class, trait and interface elements must be separated with one or none blank line. + 'class_attributes_separation' => true, + // Whitespace around the keywords of a class, trait or interfaces definition should be one space. + 'class_definition' => array('single_line' => true), + // Concatenation should be spaced according configuration. + 'concat_space' => array('spacing' => 'one'), + // The PHP constants `true`, `false`, and `null` MUST be written using the correct casing. + 'constant_case' => true, + // Equal sign in declare statement should be surrounded by spaces or not following configuration. + 'declare_equal_normalize' => true, + // Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant. + 'dir_constant' => true, + // Replaces short-echo ` true, + // The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words. + 'elseif' => true, + // PHP code MUST use only UTF-8 without BOM (remove BOM). + 'encoding' => true, + // Replace deprecated `ereg` regular expression functions with `preg`. + 'ereg_to_preg' => true, + // Error control operator should be added to deprecation notices and/or removed from other cases. + 'error_suppression' => true, + // PHP code must use the long ` true, + // Spaces should be properly placed in a function declaration. + 'function_declaration' => true, + // Replace core functions calls returning constants with the constants. + 'function_to_constant' => array('functions' => array('get_class', 'php_sapi_name', 'phpversion', 'pi')), + // Ensure single space between function's argument and its typehint. + 'function_typehint_space' => true, + // Include/Require and file path should be divided with a single space. File path should not be placed under brackets. + 'include' => true, + // Code MUST use configured indentation type. + 'indentation_type' => true, + // Replaces `is_null($var)` expression with `null === $var`. + 'is_null' => true, + // All PHP files must use same line ending. + 'line_ending' => true, + // Cast should be written in lower case. + 'lowercase_cast' => true, + // PHP keywords MUST be in lower case. + 'lowercase_keywords' => true, + // Magic constants should be referred to using the correct casing. + 'magic_constant_casing' => true, + // In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line. + 'method_argument_space' => true, + // Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator. + 'modernize_types_casting' => true, + // Function defined by PHP should be called using the correct casing. + 'native_function_casing' => true, + // All instances created with new keyword must be followed by braces. + 'new_with_braces' => true, + // Master functions shall be used instead of aliases. + 'no_alias_functions' => true, + // There should be no empty lines after class opening brace. + 'no_blank_lines_after_class_opening' => true, + // There should not be blank lines between docblock and the documented element. + 'no_blank_lines_after_phpdoc' => true, + // The closing `? >` tag MUST be omitted from files containing only PHP. + 'no_closing_tag' => true, + // There should not be any empty comments. + 'no_empty_comment' => true, + // There should not be empty PHPDoc blocks. + 'no_empty_phpdoc' => true, + // Remove useless (semicolon) statements. + 'no_empty_statement' => true, + // Removes extra blank lines and/or blank lines following configuration. + 'no_extra_blank_lines' => true, + // Remove leading slashes in `use` clauses. + 'no_leading_import_slash' => true, + // The namespace declaration line shouldn't contain leading whitespace. + 'no_leading_namespace_whitespace' => true, + // Either language construct `print` or `echo` should be used. + 'no_mixed_echo_print' => array('use' => 'echo'), + // Operator `=>` should not be surrounded by multi-line whitespaces. + 'no_multiline_whitespace_around_double_arrow' => true, + // Convert PHP4-style constructors to `__construct`. + 'no_php4_constructor' => true, + // Short cast `bool` using double exclamation mark should not be used. + 'no_short_bool_cast' => true, + // Single-line whitespace before closing semicolon are prohibited. + 'no_singleline_whitespace_before_semicolons' => true, + // When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis. + 'no_spaces_after_function_name' => true, + // There MUST NOT be spaces around offset braces. + 'no_spaces_around_offset' => true, + // There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis. + 'no_spaces_inside_parenthesis' => true, + // Remove trailing commas in list function calls. + 'no_trailing_comma_in_list_call' => true, + // PHP single-line arrays should not have trailing comma. + 'no_trailing_comma_in_singleline_array' => true, + // Remove trailing whitespace at the end of non-blank lines. + 'no_trailing_whitespace' => true, + // There MUST be no trailing spaces inside comment or PHPDoc. + 'no_trailing_whitespace_in_comment' => true, + // Removes unneeded parentheses around control statements. + 'no_unneeded_control_parentheses' => true, + // In function arguments there must not be arguments with default values before non-default ones. + 'no_unreachable_default_argument_value' => true, + // Unused `use` statements must be removed. + 'no_unused_imports' => true, + // There should not be an empty `return` statement at the end of a function. + 'no_useless_return' => true, + // In array declaration, there MUST NOT be a whitespace before each comma. + 'no_whitespace_before_comma_in_array' => true, + // Remove trailing whitespace at the end of blank lines. + 'no_whitespace_in_blank_line' => true, + // Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols. + 'non_printable_character' => true, + // Array index should always be written by using square braces. + 'normalize_index_brace' => true, + // There should not be space before or after object operators `->` and `?->`. + 'object_operator_without_whitespace' => true, + // Ordering `use` statements. + 'ordered_imports' => true, + // PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`. + 'php_unit_construct' => true, + // PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`. + 'php_unit_dedicate_assert' => true, + // PHPUnit annotations should be a FQCNs including a root namespace. + 'php_unit_fqcn_annotation' => true, + // PHPDoc should contain `@param` for all params. + 'phpdoc_add_missing_param_annotation' => array('only_untyped' => false), + // PHPDoc annotation descriptions should not be a sentence. + 'phpdoc_annotation_without_dot' => true, + // Docblocks should have the same indentation as the documented subject. + 'phpdoc_indent' => true, + // `@access` annotations should be omitted from PHPDoc. + 'phpdoc_no_access' => true, + // No alias PHPDoc tags should be used. + 'phpdoc_no_alias_tag' => true, + // We have to support `@return void` to satisfy Symfony deprecations helper. + // See https://github.com/stripe/stripe-php/pull/1230 + 'phpdoc_no_empty_return' => false, + // `@package` and `@subpackage` annotations should be omitted from PHPDoc. + 'phpdoc_no_package' => true, + // Classy that does not inherit must not have `@inheritdoc` tags. + 'phpdoc_no_useless_inheritdoc' => true, + // Annotations in PHPDoc should be ordered so that `@param` annotations come first, then `@throws` annotations, then `@return` annotations. + 'phpdoc_order' => true, + // The type of `@return` annotations of methods returning a reference to itself must the configured one. + 'phpdoc_return_self_reference' => true, + // Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`. + 'phpdoc_scalar' => true, + // Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line. + 'phpdoc_separation' => true, + // Single line `@var` PHPDoc should have proper spacing. + 'phpdoc_single_line_var_spacing' => true, + // PHPDoc summary should end in either a full stop, exclamation mark, or question mark. + 'phpdoc_summary' => true, + // Forces PHPDoc tags to be either regular annotations or inline. + 'phpdoc_tag_type' => array('tags' => array('inheritdoc' => 'inline')), + // Docblocks should only be used on structural elements. + 'phpdoc_to_comment' => true, + // PHPDoc should start and end with content, excluding the very first and last line of the docblocks. + 'phpdoc_trim' => true, + // The correct case must be used for standard PHP types in PHPDoc. + 'phpdoc_types' => true, + // `@var` and `@type` annotations of classy properties should not contain the name. + 'phpdoc_var_without_name' => true, + // Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name. + 'psr_autoloading' => true, + // There should be one or no space before colon, and one space after it in return type declarations, according to configuration. + 'return_type_declaration' => true, + // Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`. + 'short_scalar_cast' => true, + // A PHP file without end tag must always end with a single empty line feed. + 'single_blank_line_at_eof' => true, + // There should be exactly one blank line before a namespace declaration. + 'single_blank_line_before_namespace' => true, + // There MUST NOT be more than one property or constant declared per statement. + 'single_class_element_per_statement' => true, + // There MUST be one use keyword per declaration. + 'single_import_per_statement' => true, + // Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block. + 'single_line_after_imports' => true, + // Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax. + 'single_line_comment_style' => true, + // Convert double quotes to single quotes for simple strings. + 'single_quote' => true, + // Fix whitespace after a semicolon. + 'space_after_semicolon' => true, + // Replace all `<>` with `!=`. + 'standardize_not_equals' => true, + // A case should be followed by a colon and not a semicolon. + 'switch_case_semicolon_to_colon' => true, + // Removes extra spaces between colon and case value. + 'switch_case_space' => true, + // Standardize spaces around ternary operator. + 'ternary_operator_spaces' => true, + // Multi-line arrays, arguments list and parameters list must have a trailing comma. + 'trailing_comma_in_multiline' => array('elements' => array('arrays')), + // Arrays should be formatted like function/method arguments, without leading or trailing single line space. + 'trim_array_spaces' => true, + // Unary operators should be placed adjacent to their operands. + 'unary_operator_spaces' => true, + // Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility. + 'visibility_required' => array('elements' => array('property', 'method')), + // In array declaration, there MUST be a whitespace after each comma. + 'whitespace_after_comma_in_array' => true, + // Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration. + 'yoda_style' => array('always_move_variable' => false, 'equal' => false, 'identical' => false, 'less_and_greater' => false), + // Make type definition of default null also nullable to avoid PHP 8.4 deprecations + 'nullable_type_declaration_for_default_null_value' => true, + )) + ->setFinder( + PhpCsFixer\Finder::create() + ->exclude('vendor') + ->in(array( + __DIR__ . '/src', + __DIR__ . '/tests', + )) + ->append(array(__FILE__)) + ) +; diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 566c91607..000000000 --- a/.travis.yml +++ /dev/null @@ -1,57 +0,0 @@ -language: php - -env: - - IMAGINE_DRIVER=imagick - - IMAGINE_DRIVER=gmagick - -before_install: - - composer self-update - -install: - - composer install --prefer-source - - sudo apt-get remove -y imagemagick libmagickcore-dev libmagickwand-dev - - sudo apt-get install -y libtiff-dev libjpeg-dev libdjvulibre-dev libwmf-dev pkg-config - - echo '' > ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini - - sh -e -c " if [ '$IMAGINE_DRIVER' = 'imagick' ]; then - wget http://www.imagemagick.org/download/releases/ImageMagick-6.8.9-10.tar.xz; - tar -xf ImageMagick-6.8.9-10.tar.xz; - cd ImageMagick-6.8.9-10; - ./configure --prefix=/opt/imagemagick; - make -j; - sudo make install; - export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/opt/imagemagick/lib/pkgconfig; - sudo ln -s /opt/imagemagick/include/ImageMagick-6 /opt/imagemagick/include/ImageMagick; - cd ..; - wget http://pecl.php.net/get/imagick-3.2.0RC1.tgz; - tar -xzf imagick-3.2.0RC1.tgz; - cd imagick-3.2.0RC1; - phpize; - ./configure --with-imagick=/opt/imagemagick; - make -j; - sudo make install; - echo \"extension=imagick.so\" >> `php --ini | grep \"Loaded Configuration\" | sed -e \"s|.*:\s*||\"`; - php --ri imagick; - fi" - - sh -e -c " if [ '$IMAGINE_DRIVER' = 'gmagick' ]; then - sudo apt-get install -y graphicsmagick libgraphicsmagick1-dev; - wget http://pecl.php.net/get/gmagick-1.1.7RC2.tgz; - tar -xzf gmagick-1.1.7RC2.tgz; - cd gmagick-1.1.7RC2; - phpize; - ./configure --with-gmagick=/usr/local; - make -j; - sudo make install; - echo \"extension=gmagick.so\" >> `php --ini | grep \"Loaded Configuration\" | sed -e \"s|.*:\s*||\"`; - php --ri gmagick; - fi" - -php: - - 5.3 - - 5.4 - - 5.5 - - 5.6 - - 7.0 - -matrix: - allow_failures: - - php: 7.0 diff --git a/.travis/autoupdate-api.sh b/.travis/autoupdate-api.sh new file mode 100755 index 000000000..361b9f9dc --- /dev/null +++ b/.travis/autoupdate-api.sh @@ -0,0 +1,71 @@ +#!/bin/bash + +set -o errexit + +AUTO_REPOSITORY_OWNER='avalanche123' +AUTO_REPOSITORY_NAME='Imagine' +AUTO_PROCESS_BRANCH='develop' +AUTO_COMMIT_NAME='[skip ci] Automatic API update' +AUTO_COMMIT_AUTHOR_NAME='Michele Locati' +AUTO_COMMIT_AUTHOR_EMAIL='michele@locati.it' + +if test "${TRAVIS_PULL_REQUEST:-}" != 'false'; then + echo "Automatic API generation: skipping because it's a pull request." + exit 0 +fi + +if test "${TRAVIS_BRANCH:-}" != "${AUTO_PROCESS_BRANCH}"; then + echo "Automatic API generation: skipping because pushing to '${TRAVIS_BRANCH:-}' instead of '${AUTO_PROCESS_BRANCH}'." + exit 0 +fi + +if test "${TRAVIS_REPO_SLUG:-}" != "${AUTO_REPOSITORY_OWNER}/${AUTO_REPOSITORY_NAME}"; then + echo "Automatic API generation: skipping because repository is '${TRAVIS_REPO_SLUG:-}' instead of '${AUTO_REPOSITORY_OWNER}/${AUTO_REPOSITORY_NAME}'." + exit 0 +fi + +if test -z "${TRAVIS_COMMIT_MESSAGE:-}"; then + echo "Automatic API generation: skipping because commit message is unavailable." + exit 0 +fi +if test "${TRAVIS_COMMIT_MESSAGE}" = "${AUTO_COMMIT_NAME}"; then + echo "Automatic API generation: skipping because commit is already '${AUTO_COMMIT_NAME}'." + exit 0 +fi + +if test -z "${GUTHUB_ACCESS_TOKEN:-}"; then + printf 'Automatic API generation: skipping because GUTHUB_ACCESS_TOKEN is not available +To create it: + - go to https://github.com/settings/tokens/new + - create a new token + - sudo apt update + - sudo apt install -y build-essential ruby ruby-dev + - sudo gem install travis + - travis encrypt --repo %s/%s GUTHUB_ACCESS_TOKEN= + - Add to the env setting of: + secure: "encrypted string" +' "${AUTO_REPOSITORY_OWNER}" "${AUTO_REPOSITORY_NAME}" + exit 0 +fi + +echo "Automatic API generation: updating API" +cd "${TRAVIS_BUILD_DIR}" +git checkout -qf "${AUTO_PROCESS_BRANCH}" +cd "${TRAVIS_BUILD_DIR}/docs/_build" +rm -rf ../API +composer --no-interaction install +composer --no-interaction update-docs + +cd "${TRAVIS_BUILD_DIR}/docs/API" +if test -z "$(git status --porcelain .)"; then + echo "Automatic API generation: skipping because API is already up-to-date" + exit 0 +fi +echo "Automatic API generation: changes detected - commiting and pushing changed." +git add --all . +git config user.name "${AUTO_COMMIT_AUTHOR_NAME}" +git config user.email "${AUTO_COMMIT_AUTHOR_EMAIL}" +git commit -m "${AUTO_COMMIT_NAME}" +git remote add deploy "https://$%7BGUTHUB_ACCESS_TOKEN%7D@github.com/$%7BAUTO_REPOSITORY_OWNER%7D/$%7BAUTO_REPOSITORY_NAME%7D.git" +git push deploy "${AUTO_PROCESS_BRANCH}" +echo "Automatic API generation: repository updated." diff --git a/CHANGELOG.md b/CHANGELOG.md index 4bc488851..0357e23b0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,174 +1,306 @@ # CHANGELOG +### NEXT (YYYY-MM-DD) + + +### 1.5.0 (2024-12-03) +- Minimum supported PHP version raised from 5.5 to 7.1 (#865, @alexander-schranz) +- Fix PHP 8.4 deprecation warnings (#865, @alexander-schranz) +- The GD driver now supports resolution for PHP >= 7.2 (#813, #866, @gutocf, @mlocati) + +### 1.4.0 (2024-11-10) +- If a file couldn't be found, we now throw a NotFoundException exception (#853, @playmono) +- Add support for webp_lossless to GD and GMagick (#858, @ausi) +- Use streams in ExifMetadataReader (#861, @ausi) +- WebP format now supports animation (#812, @Yoann-TYT) + +### 1.3.5 (2023-06-07) +* Fix PHP 8.2 warnings with Point class (#847, @anovsiradj) + +### 1.3.4 (2023-04-17) +* Let PHP automatically detect the preferred TLS version (#841, @radli) +* Add @return phpdoc to ReturnTypeWillChange methods (#846, @mlocati) + +### 1.3.3 (2022-11-16) +* Fix invalid format MIME type definition (#835, @xdanik) + +### 1.3.2 (2022-04-01) +* Workaround for a bug in PHP 7.3+opcache that causes segmentation faults (#826, #829, #828, @ausi, @mnocon, @mlocati) + +### 1.3.1 (2022-03-15) +* Fix undefined variable $engineRawVersion in Imagick/Gmagick DriverInfo (#825, @fxbt) + +### 1.3.0 (2022-03-15) +* Minimum PHP supported version is now 5.5 (#820, @PowerKiKi) +* Support AVIF, HEIC, and JXL in Imagick driver (#759, #765, @ausi) +* Support AVIF in GD driver (#791, @mlocati) +* Make the $filter parameter of the resize method invariant (#776, @mlocati) +* Ability to specify the alpha-blending of the GD drawer (#790, @mlocati) +* Add support for SINCFAST filter in Imagick driver (#823, @mlocati) +* Fix applyMask() for GD driver (#708, @ninze) +* Fix PHP 8.1 compatibility (#768, #791, @ausi, @mlocati) +* Fix error handling in grayscale() for Gmagick driver (#757, @dmitry-kulikov) +* Fix convolve() for Imagick driver (#775, @mlocati) +* Fix array retuned by histogram() method of GD and Imagick drivers (#797, @mlocati) +* Fix handling alpha channel in Imagick (#775, #798, @mlocati) +* New Driver\Info classes to inspect installed drivers (#802, #805, #806, @mlocati) +* Fix wrong load logic in Imagick (#807, @mlocati) + +### 1.2.4 (2020-11-03) +* Fix PHP 8.0 compatibility, except gmagick - see https://bugs.php.net/bug.php?id=80106 (#740, @ausi) +* Optimize reading EXIF metadata from local files (#741, @jorrit) +* Fix rotation with imagick (#734, @lashus @ausi) +* Fix saving multi-layer images (eg animated GIFs) as plain images with gmagick and imagick (#746, @alexander-schranz @mlocati) +* Fix gmagick not resolving the correct export format in some edge cases (#750, @ausi) + +### 1.2.3 (2019-12-04) +* Handle jfif extension in GD driver (#727, @sylvain-msl-talkspirit) +* Improve detection of unsupported Exit Metadata Reader (#729, @mlocati, @ausi) + +### 1.2.2 (2019-07-09) +* The GD driver can now load WebP files (#711, #718, @lashus, @ausi) +* Avoid calling `imageantialias` if it's not available (#713, @ahukkanen) + +### 1.2.1 (2019-06-03) +* Silence call to `\Imagick::setImageOpacity()` in order to prevent deprecation error with Imagick 3.4.4 and ImageMagick 6 (#715, @samdark, @mlocati) + +### 1.2.0 (2018-12-07) +* `ExifMetadataReader` now returns all the available metadata, not only EXIF and IFD0 (#701, @mlocati) + +### 1.1.0 (2018-10-25) +* New `ImageInterface::THUMBNAIL_FLAG_NOCLONE` flag for `thumbnail()` to let it modify the original image instance in order to save memory (@mlocati) + +### 1.0.2 (2018-10-24) +* Check that the Imagick PHP extension is not compiled using ImageMagick version 7.0.7-32 because it does not work correctly (@mlocati) + +### 1.0.1 (2018-09-27) +* `Box` now rounds the width/height it receives (previously it discarded the decimal points) (@mlocati) + +### 1.0.0 (2018-09-25) +* New `FontInterface` method: `wrapText` - split a text into multiple lines, so that it fits a specific width (@mlocati) + **BREAKING CHANGE** if you have your own `FontInterface` implementation, it now must implement `wrapText` +* Drawer methods can now accept a thickness of zero (@mlocati) +* Fix drawing unfilled chords with GD driver (@mlocati) +* Fix thickness drawing of unfilled chords with Imagick and Gmagick drivers (@mlocati) +* Fix handling of radius in `circle` method implementations (@mlocati) +* The `dissolve` method of `ColorInterface` normalizes the final value of alpha (@mlocati) + **BREAKING CHANGE** `dissolve` doesn't throw a `Imagine\Exception\InvalidArgumentException` anymore + +### 1.0.0-alpha2 (2018-09-08) +* The `coalesce` method of `LayerInterface` instances now returns the LayerInterface itself (@mlocati) + **BREAKING CHANGE** if you have your own `LayerInterface` implementation, it now must return `$this` +* The `__toString` method has been added to `ColorInterface` since all its implementations have it (@mlocati) + **BREAKING CHANGE** if you have your own `ColorInterface` implementation, it now must implement `__toString` +* New Imagick save option: `optimize` if set, the size of animated GIF files is optimized (@mlocati) + **NOTE** Imagick requires that the image frames have the same size +* The `paste` method now accepts images not fully included in the destination image (@mlocati) + **BREAKING CHANGE** the paste method doesn't throw an OutOfBoundsException anymore +* Fix handling of PNG compression in Imagick `save` method (@mlocati) +* New drawer methods: `rectangle` and `circle` (@mlocati) + **BREAKING CHANGE** if you have your own implementation of `DrawerInterface` you should add these two new methods +* The `getChannelsMaxValue` method has been added to `PaletteInterface` (@mlocati) + **BREAKING CHANGE** if you have your own `PaletteInterface` implementation, it now must implement this new method + +### 1.0.0-alpha1 (2018-08-28) +* Imagine is now tested under Windows too (@mlocati) +* Add support to webp image format (@chregu, @antoligy, @alexander-schranz) +* Add `Imagine\File\LoaderInterface` that allows loading remote images with any imaging driver (@mlocati). + You can use your own `LoaderInterface` implementation so that you can for instance use curl or any other library. +* Fix some phpdoc issues (@mlocati) +* `flipHorizontally` and `flipVertically` methods of GD images is now much faster on PHP 5.5+ (@mlocati) +* Fix loading of PNG indexed images with GD (@mlocati) +* Loading indexed images with GD is now much faster on PHP 5.5+ (@mlocati) +* Add support to grayscale images with Gmagick (@mlocati) +* Add support to alpha channels of Gmagick images (@mlocati) +* Fix `getColorAt` method of Gmagick images (@mlocati) +* Add `getTransformations` to the `Autorotate` filter, so that you can get the list of transformations that should be applied to an image accordingly to the EXIF metadata (@mlocati) +* The metadata reader now doesn't throw exceptions or warnings (@lentex, @mlocati) +* Fix documentation (@ZhangChaoWN, @Mark-H, @mlocati) +* Fix pixel range issue with Gmagick image (@b-viguier) +* Fix `text` drawer method on Windows when using relative font file paths (@mlocati) +* Fix `box` font method on Windows when using relative font file paths (@mlocati) +* Fix crash on Windows when loading an image with Imagick (@mlocati) +* Fix generation of API documentation (@mlocati) +* Add `jpeg_sampling_factors` option when saving JPEG images (Gmagick/Imagick only) (@ausi) +* Add BMP as supported image format (@mlocati) +* Add support to new image type constants of Imagick (@ausi) +* Check that Imagick correctly supports profiles (@ausi) +* Add `setMetadataReader`/`getMetadataReader` to `ImagineInterface` (@mlocati) + **BREAKING CHANGE** if you have your own `ImagineInterface` implementation, it now must implement those two methods +* Fix creating Gmagick images with alpha colors when palette doesn't support alpha (@FractalizeR) +* Fix warning about deprecated clone method in copy method of Imagick images (@mlocati) +* Fix copy methods of Images (the original image and its new copy are now fully detached) (@mlocati) +* It's now possible to use `clone $image` as an alternative to `$image->copy()` (@mlocati) +* Add support to custom classes for `BoxInterface`, `MetadataReaderInterface`, `FontInterface`, `LoaderInterface`, `LayersInterface`, `ImageInterface` (@mlocati) + **BREAKING CHANGE** if you have your own `ImagineInterface` implementation, it now must implement the methods of `ClassFactoryAwareInterface` +* Add support for pasting with alpha for GD and Imagick (@AlloVince, @mlocati) +* Downscaling a `Box` until it reaches a dimension less than 1 returns a box with dimension of 1 instead of throwing an exception (@mlocati) + **BREAKING CHANGE** if you relied on `Box::scale` throwing an exception in this case +* New filters: `BlackWhite`, `BorderDetection`, `Negation`, `Neighborhood` (@rejinka) +* Minor optimization of filters based on `OnPixelBased` (@rejinka, @mlocati) +* Add flag to `thumbnail` to allow upscaling images (@vlakoff) + **BREAKING CHANGE** the `$mode` argument has been renamed to `$settings`, and it's now an integer (but old string values are accepted for backward compatibility). In this case the `ManipulatorInterface` constants `THUMBNAIL_INSET`, `THUMBNAIL_OUTBOUND` were changed from string values to integers. +* New filter: `brightness` (@lenybernard, @mlocati) +* New filter: `colvolve` available for all graphics libraries except gmagick with version prior to 2.0.1RC2 (@armatronic, @mlocati) +* Fix bug in Imagine\Image\Palette\RGB::blend() (@dmolineus, @mlocati) +* Autoload was moved from PSR-0 to PSR-4, and code files moved from `/lib/Imagine` to `/src` (@mlocati) + +### 0.7.1 (2017-05-16) +* Remove Symfony PHPUnit bridge as dependency (@craue) + +### 0.7.0 (2017-05-02) +* Fix memory usage on metadata reading (@Seldaek) +* PHP 7.1 support +* Latest Imagemagick compatibility (@jdewit) + ### 0.6.3 (2015-09-19) - * Fix wrong array_merge when calling Transformation::getFilters without filters - * Add export-ignore git attribute (@Benoth) - * Fix docblocks (@Sm0ke0ut and @norkunas) - * Fix animated gif loop length options (@jygaulier) - * Multiple tweaks for the repository and travis builds (@localheinz, @vrkansagara and @dunzun) - * Fix metadata extraction from streams (@armatronic) - * Fix autorotation (@tarleb) - * Load exifmetadata reader whenever possible - * Add metadata getter +* Fix wrong array_merge when calling Transformation::getFilters without filters +* Add export-ignore git attribute (@Benoth) +* Fix docblocks (@Sm0ke0ut and @norkunas) +* Fix animated gif loop length options (@jygaulier) +* Multiple tweaks for the repository and travis builds (@localheinz, @vrkansagara and @dunzun) +* Fix metadata extraction from streams (@armatronic) +* Fix autorotation (@tarleb) +* Load exifmetadata reader whenever possible +* Add metadata getter ### 0.6.2 (2014-11-11) - * Stripping image containing an invalid ICC profile fails - * MetadataBag now implements \Countable - * Fix wrong array_merge in MetadataBag giving invalid results with HTTP resources (@javaguirre) - * Fix Imagick merge strategy (@GrahamCampbell) - * Fixed various alpha issues (@RadekDvorak) - * Fix Image cloning on HHVM (@RdeWilde) - * Fix exception on invalid file using GD driver (@vlakoff). - * Fix ImageInterface::getSize on animated GIFs (@sokac) +* Stripping image containing an invalid ICC profile fails +* MetadataBag now implements \Countable +* Fix wrong array_merge in MetadataBag giving invalid results with HTTP resources (@javaguirre) +* Fix Imagick merge strategy (@GrahamCampbell) +* Fixed various alpha issues (@RadekDvorak) +* Fix Image cloning on HHVM (@RdeWilde) +* Fix exception on invalid file using GD driver (@vlakoff). +* Fix ImageInterface::getSize on animated GIFs (@sokac) ### 0.6.1 (2014-06-16) - * Fix invalid namespace usage (#336 @csanquer). +* Fix invalid namespace usage (#336 @csanquer). ### 0.6.0 (2014-06-13) - - * BC break: Colors are now provided through the PaletteInterface. Any call - to previous Imagine\Image\Color constructor must be removed and use the - palette provided by Imagine\Image\ImageInterface::getPalette to create - colors. - * BC break : Animated GIF default delay is no longer 800ms but null. This - avoids resettings a delay on animated image. - * Add support for ICC profiles - * Add support for CMYK and grayscale colorspace images. - * Add filter argument to ImageInterface::thumbnail method. - * Add priority to filters (@Richtermeister). - * Add blur effect (@Nokrosis). - * Rename "quality" option to "jpeg_quality" and apply it only to JPEG files (@vlakoff). - * Add "png_compression_level" option (@vlakoff). - * Rename "filters" option to "png_compression_filter" (@vlakoff). - * Deprecate `quality` and `filters` ManipulatorInterface::save options, use - `jpeg_quality`, `png_compression_level` and `png_compression_filter` instead. - * Add support for alpha blending in GD drawer (@salem). - * Add width parameter to Drawer::text (@salemgolemugoo). - * Add NotSupportedException when a driver does not support an operation (@rouffj). - * Add support for metadata. - * Fix #158: GD alpha detection + Color::isOpaque are broken. - * Fix color extraction for non-RGB palettes. +* BC break: Colors are now provided through the PaletteInterface. Any call + to previous Imagine\Image\Color constructor must be removed and use the + palette provided by Imagine\Image\ImageInterface::getPalette to create + colors. +* BC break : Animated GIF default delay is no longer 800ms but null. This + avoids resettings a delay on animated image. +* Add support for ICC profiles +* Add support for CMYK and grayscale colorspace images. +* Add filter argument to ImageInterface::thumbnail method. +* Add priority to filters (@Richtermeister). +* Add blur effect (@Nokrosis). +* Rename "quality" option to "jpeg_quality" and apply it only to JPEG files (@vlakoff). +* Add "png_compression_level" option (@vlakoff). +* Rename "filters" option to "png_compression_filter" (@vlakoff). +* Deprecate `quality` and `filters` ManipulatorInterface::save options, use + `jpeg_quality`, `png_compression_level` and `png_compression_filter` instead. +* Add support for alpha blending in GD drawer (@salem). +* Add width parameter to Drawer::text (@salemgolemugoo). +* Add NotSupportedException when a driver does not support an operation (@rouffj). +* Add support for metadata. +* Fix #158: GD alpha detection + Color::isOpaque are broken. +* Fix color extraction for non-RGB palettes. ### 0.5.0 (2013-07-10) - - * Add `Layers::coalesce`. - * Add filter option to `ImageInterface::resize`. - * Add sharpen effect. - * Add interlace support. - * `LayersInterface` now extends `ArrayAccess`, gives support for animated gifs. - * Remove Imagick and Gmagick flatten after composite. - * Fix pixel opacity reading in `Gmagick::histogram`. - * Deprecate pear channel installation. - * Deprecate phar installation. +* Add `Layers::coalesce`. +* Add filter option to `ImageInterface::resize`. +* Add sharpen effect. +* Add interlace support. +* `LayersInterface` now extends `ArrayAccess`, gives support for animated gifs. +* Remove Imagick and Gmagick flatten after composite. +* Fix pixel opacity reading in `Gmagick::histogram`. +* Deprecate pear channel installation. +* Deprecate phar installation. ### 0.4.1 (2012-12-13) - - * Lazy-load GD layers. +* Lazy-load GD layers. ### 0.4.0 (2012-12-10) - - * Add support for image Layers. - * Add Colorize effect. - * Add documentation for the Grayscale effect. - * Port RelativeResize filter from JmikolaImagineBundle. +* Add support for image Layers. +* Add Colorize effect. +* Add documentation for the Grayscale effect. +* Port RelativeResize filter from JmikolaImagineBundle. ### 0.3.1 (2012-11-12) - - * Add Grayscale effect. - * `Drawer::text` position fix. +* Add Grayscale effect. +* `Drawer::text` position fix. ### 0.3.0 (2012-07-28) - - * Add configurable border thickness to drawer interface and implementations. - * Add `ImageInterface`::strip. - * Add Canvas filter. - * Add resolution option on image saving. - * Add Grayscale filter. - * Add sami API documentation. - * Add compression quality to Gmagick. - * Add effects API. - * Add method to get pixel at point in Gmagick. - * Ensure valid background color in rotations. - * Fill lines with color to prevent semi-transparency issues. - * Use `Imagick::resizeImage` instead of `Imagick::thumbnailImage` for resizing. - * Fix PNG transparency on save ; do not flatten if not necessary. +* Add configurable border thickness to drawer interface and implementations. +* Add `ImageInterface`::strip. +* Add Canvas filter. +* Add resolution option on image saving. +* Add Grayscale filter. +* Add sami API documentation. +* Add compression quality to Gmagick. +* Add effects API. +* Add method to get pixel at point in Gmagick. +* Ensure valid background color in rotations. +* Fill lines with color to prevent semi-transparency issues. +* Use `Imagick::resizeImage` instead of `Imagick::thumbnailImage` for resizing. +* Fix PNG transparency on save ; do not flatten if not necessary. ### 0.2.8 (2011-11-29) - - * Add support for Travis CI. +* Add support for Travis CI. ### 0.2.7 (2011-11-17) - - * Use composer for autoloading. +* Use composer for autoloading. ### 0.2.6 (2011-11-09) - - * Documentation enhancements. +* Documentation enhancements. ### 0.2.5 (2011-10-29) - - * Add PEAR support. - * Documentation enhancements. +* Add PEAR support. +* Documentation enhancements. ### 0.2.4 (2011-10-17) - - * Add imagine.phar, phar and rake tasks. - * Add `ImagineInterface::read` to read from a stream resource. - * Documentation enhancements. - * Fix gifs transparency issues. +* Add imagine.phar, phar and rake tasks. +* Add `ImagineInterface::read` to read from a stream resource. +* Documentation enhancements. +* Fix gifs transparency issues. ### 0.2.3 (2011-10-16) - - * Documentation enhancements. +* Documentation enhancements. ### 0.2.2 (2011-10-16) - - * Documentation enhancements. +* Documentation enhancements. ### 0.2.1 (2011-10-15) - - * Add `PointInterface::move`. - * `BoxInterface::scale` can accept floats. - * Set antialias mode for GD images. - * Fix png compression. +* Add `PointInterface::move`. +* `BoxInterface::scale` can accept floats. +* Set antialias mode for GD images. +* Fix png compression. ### 0.2.0 (2011-10-06) - - * Add `Imagine\Fill\Gradient\Linear::getStart`/`getEnd`. - * Add `Imagine\Image\Color::isOpaque`. - * Add Gmagick transparency exceptions. - * Add support for transparency for gif export. - * Add widen/heighten methods for easy scaling to target width/height. - * Add functionals tests to unit test thumbnails creation. - * Add the ability to use hexadecimal notation for `Imagine\Image\Color` construction. - * Implement fast linear gradient for Imagick. - * Remove lengthy image histogram comparisons. - * Extract `ManipulatorInterface` from `ImageInterface`. - * Switch methods to final. - * New method `ImageInterface::getColorAt`. - * Introduce `ImagineAware` abstract filter class. +* Add `Imagine\Fill\Gradient\Linear::getStart`/`getEnd`. +* Add `Imagine\Image\Color::isOpaque`. +* Add Gmagick transparency exceptions. +* Add support for transparency for gif export. +* Add widen/heighten methods for easy scaling to target width/height. +* Add functionals tests to unit test thumbnails creation. +* Add the ability to use hexadecimal notation for `Imagine\Image\Color` construction. +* Implement fast linear gradient for Imagick. +* Remove lengthy image histogram comparisons. +* Extract `ManipulatorInterface` from `ImageInterface`. +* Switch methods to final. +* New method `ImageInterface::getColorAt`. +* Introduce `ImagineAware` abstract filter class. ### 0.1.5 (2011-05-18) - - * Fix bug in GD rotate. +* Fix bug in GD rotate. ### 0.1.4 (2011-03-21) - - * Add environment check to gracefuly skip test. +* Add environment check to gracefuly skip test. ### 0.1.3 (2011-03-21) - - * Improve api docs. - * Extract `FontInterface`. +* Improve api docs. +* Extract `FontInterface`. ### 0.1.2 (2011-03-21) - - * Add check for GD. +* Add check for GD. ### 0.1.1 (2011-03-21) - - * Add rounding and fixed thumbnail logic. +* Add rounding and fixed thumbnail logic. ### 0.1.0 (2011-03-14) - - * First tagged version. +* First tagged version. diff --git a/LICENSE b/LICENSE index 2aefaeecf..8de9133cf 100644 --- a/LICENSE +++ b/LICENSE @@ -21,5 +21,5 @@ THE SOFTWARE. This software embeds Adobe ICC Profiles, see license at http://www.adobe.com/support/downloads/iccprofiles/icc_eula_mac_dist.html . -This sofwtare also embeds ICC Profile from colormanagement.org. Please +This software also embeds ICC Profile from colormanagement.org. Please find information about their license at http://colormanagement.org/ . diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 000000000..89da709b3 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,30 @@ +# Maintainers Instructions + +This document contains some instructions for the repository maintainers. + + +## Publishing a new Imagine release + +Follow these instructions when publishing a new Imagine release: + +1. Be sure that GitHub Action tests succesfully completed in the `develop` branch +2. Update the `CHANGELOG.md` file: + - replace the `### NEXT (YYYY-MM-DD)` line with the release number and date +3. Set the new version in the `Imagine\Image\ImagineInterface::VERSION` constant: + - it's defined in the file `src/Image/ImagineInterface.php` +4. Commit these changes and push to the `develop` branch +5. Wait until TravisCI jobs complete succesfully + - one of those jobs should automatically add a new commit to the `develop` branch, updating the API docs +6. Create a new release on GitHub + - Go to https://github.com/avalanche123/Imagine/releases/new and enter this data: + - Tag version: the new version (just the numbers/dots - for example `1.2.3`) + - Release title: the new version (with a leating `v` - for example `v1.2.3`) + - Release description: copy the relevant section from the `CHANGELOG.md` file + - the new release should appear on https://imagine.readthedocs.io in a short time +7. Fast forward the `master` branch to this new tag (for example `1.2.3`) +8. Wait until TravisCI jobs complete +9. Update the `CHANGELOG.md` file: + - add a new `### NEXT (YYYY-MM-DD)` line +10. Set the new development version in the `Imagine\Image\ImagineInterface::VERSION` constant: + - it's defined in the file `src/Image/ImagineInterface.php` +11. Drink a beer to celebrate the new version diff --git a/README.md b/README.md index 311cb9fb1..cfb85b181 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,36 @@ -#Imagine -[![project status](http://stillmaintained.com/avalanche123/Imagine.png)](http://stillmaintained.com/avalanche123/Imagine) -[![Build Status](https://travis-ci.org/avalanche123/Imagine.svg?branch=develop)](https://travis-ci.org/avalanche123/Imagine) +# Imagine +[![PHPUnit](https://github.com/php-imagine/Imagine/actions/workflows/phpunit.yml/badge.svg)](https://github.com/php-imagine/Imagine/actions/workflows/phpunit.yml) +[![Coding Style](https://github.com/php-imagine/Imagine/actions/workflows/coding-style.yml/badge.svg)](https://github.com/php-imagine/Imagine/actions/workflows/coding-style.yml) Tweet about it using the [#php_imagine](https://twitter.com/search?q=%23php_imagine) hashtag. -Image manipulation library for PHP 5.3 inspired by Python's PIL and other image +Image manipulation library for PHP inspired by Python's PIL and other image libraries. -##Requirements## +## Requirements The Imagine library has the following requirements: - - PHP 5.3+ + - PHP 7.1+ -Depending on the chosen Image implementation, you may need one of the following: +Older version of the library support also older PHP Version: + + - PHP 5.5 - 7.0 use version ^1.3 + - PHP 5.3 - 5.4 use version ^1.2 + +Depending on the chosen Image implementation, you may need one of the following PHP extensions: - GD2 - - Imagick + - Imagick (with ImageMagick version 6.2.9 or later, except version 7.0.7-32) - Gmagick +To read EXIF metadata (e.g. for autorotation), activate the PHP ``exif`` extension. This is optional: Imagine works +without the PHP ``exif`` extension, but then it can't read and act on image orientation or other EXIF metadata. + ### Installation using composer `php composer.phar require imagine/imagine` -##Basic Principles## +## Basic Principles The main purpose of Imagine is to provide all the necessary functionality to bring all native low level image processing libraries in PHP to the same simple and intuitive OO API. @@ -52,3 +60,62 @@ Some of the ideas for upcoming filters: ## Articles ## - [Image Processing with Imagine](http://www.phparch.com/2011/03/image-processing-with-imagine) + +## Contributing ## + +### Branches + +New pull requests should be based on the `develop` branch. +The `master` branch is the stable branch: it usually matches the latest a release but in can be a bit ahead. + +### Test groups + +Some PHPUnit test is marked as skipped (for example, tests that require a driver that support multiple layers and executed with the GD driver). +In addition, if you don't have installed gmagick, the gmagick tests will be marked as skipped. + +If you don't want to run tests that are marked as "always skipped" you can tell PHPUnit to exclude the `always-skipped` group. +The same for the tests that require a specific driver (`gd`, `imagick`, `imagick`). + +So, for example, to exclude the `always-skipped` and the `gmagick` tests, you can launch phpunit with this command options: + +``` +composer run test -- --exclude-group always-skipped,gmagick +``` + + +### Development environment + +Setting up an environment with all the required libraries may be very hard. +In order to run the tests locally, you can use the same [docker images](https://github.com/php-imagine/docker-builder/pkgs/container/test) used by Imagine to test the pull requests. + +For example, if you have Imagine locally in the `/home/me/imagine` folder, you can run tests for PHP 8.1 with the GD and Imagick with this very simple approach: + +1. Launch a temporary docker container with: + ```sh + docker run --rm -it -v /home/me/imagine:/app -w /app ghcr.io/php-imagine/test:8.1-gd-imagick bash + ``` +2. Inside the docker container, run these commands: + ```sh + # Start a local web server: some tests require it + cd tests + php -n -S 0.0.0.0:8013 >/dev/null 2>&1 & + cd .. + # Tell the tests that the local web server is available at the port 8013 + export IMAGINE_TEST_WEBSERVERURL=http://localhost:8013 + # Install the composer dependencies + composer update + # Run the tests + composer run test -- --exclude-group always-skipped,gmagick + ``` + +> Note: This approach works on Windows too: simply launch the docker container with +> ``` +> docker run --rm -it -v C:\Path\To\Imagine:/app -w /app ghcr.io/php-imagine/test:8.1-gd-imagick bash +> ``` + +### Built test files + +Many tests create temporary files (in the `tests/tmp` directory) containing built images. +Those temporary files are compared with expected images, and then are deleted. +If you want to keep those temporary files (for example, to check what's being built), you can set the `IMAGINE_TEST_KEEP_TEMPFILES` environment variable. +If the `IMAGINE_TEST_KEEP_TEMPFILES` is configured in the GitHub Action tests, those temporary files are attached to tests as an articact. diff --git a/composer.json b/composer.json index d1a3778f4..2e47c0639 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "imagine/imagine", - "description": "Image processing for PHP 5.3", + "description": "Image processing for PHP", "keywords": [ "image manipulation", "image processing", @@ -16,28 +16,31 @@ "homepage": "http://avalanche123.com/" } ], - "config": { - "bin-dir": "bin" - }, "require": { - "php": ">=5.3.2" + "php": ">=7.1" }, "require-dev": { - "sami/sami": "dev-master" + "phpunit/phpunit": "^4.8 || ^5.7 || ^6.5 || ^7.5 || ^8.4 || ^9.3" }, "suggest": { + "ext-exif": "to read EXIF metadata", "ext-gd": "to use the GD implementation", "ext-imagick": "to use the Imagick implementation", "ext-gmagick": "to use the Gmagick implementation" }, "autoload": { - "psr-0": { - "Imagine": "lib/" + "psr-4": { + "Imagine\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "Imagine\\Test\\": "tests/tests/" } }, "extra": { "branch-alias": { - "dev-develop": "0.7-dev" + "dev-develop": "1.x-dev" } }, "archive": { @@ -51,5 +54,8 @@ "imagine-*.phar", "composer.phar" ] + }, + "scripts": { + "test": "phpunit --verbose" } } diff --git a/docs/API/API/Imagine.html b/docs/API/API/Imagine.html index 1307de668..10aec041d 100644 --- a/docs/API/API/Imagine.html +++ b/docs/API/API/Imagine.html @@ -1,33 +1,94 @@ - - - - Imagine | - - - -
- - -
- -
Namespace
-

Imagine

+ + + + Imagine | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
    4. +
-
+
+
+

Imagine

+
+ +

Namespaces

+
+ Imagine\DrawImagine\EffectsImagine\ExceptionImagine\FactoryImagine\FileImagine\FilterImagine\GdImagine\GmagickImagine\ImageImagine\ImagickImagine\Utils
+ + +
-
+ diff --git a/docs/API/API/Imagine/Draw.html b/docs/API/API/Imagine/Draw.html index ff8f278e0..16d17b070 100644 --- a/docs/API/API/Imagine/Draw.html +++ b/docs/API/API/Imagine/Draw.html @@ -1,40 +1,104 @@ - - - - Imagine\Draw | - - - -
- - -
- -
Namespace
-

Imagine\Draw

+ + + + Imagine\Draw | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Draw
  5. \
    6. +
-
+
+
+

Imagine\Draw

+
+ + +

Interfaces

- - - - - -
DrawerInterfaceInterface for the drawer
+ +
+
+
+ DrawerInterface + +
+
+ Interface for the drawer. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Draw/DrawerInterface.html b/docs/API/API/Imagine/Draw/DrawerInterface.html index 990daaf4d..8e3fa1c73 100644 --- a/docs/API/API/Imagine/Draw/DrawerInterface.html +++ b/docs/API/API/Imagine/Draw/DrawerInterface.html @@ -1,197 +1,353 @@ - - - - Imagine\Draw\DrawerInterface | - - - -
- - -
- -
Interface
-

Imagine\Draw\DrawerInterface

+ + + + Imagine\Draw\DrawerInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

interface - DrawerInterface

-
-

Interface for the drawer

-

-

+
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Draw
  5. \
  6. DrawerInterface
    7. +
+
+ +
+

+ DrawerInterface + +

+
+ +

interface + DrawerInterface +

+ + + + +
+

Interface for the drawer.

+

Methods

- - - - - - +
+
+
+ $this +
+
+ arc(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, int $thickness = 1) + +

Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.

+
+
+
+
+ $this +
+
+ chord(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Same as arc, but also connects end points with a straight line.

+
+
+
+
+ $this +
+
+ circle(PointInterface $center, int $radius, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws and circle with center at the given x, y coordinates, and given radius.

+
+
+
+
+ $this +
+
+ ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws and ellipse with center at the given x, y coordinates, and given width and height.

+
+
+
+
+ $this +
+
+ line(PointInterface $start, PointInterface $end, ColorInterface $outline, int $thickness = 1) + +

Draws a line from start(x, y) to end(x, y) coordinates.

+
+
+
+
+ $this +
+
+ pieSlice(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Same as arc, but connects end points and the center.

+
+
+
+
+ $this +
+
+ dot(PointInterface $position, ColorInterface $color) + +

Places a one pixel point at specific coordinates and fills it with +specified color.

+
+
+
+
+ $this +
+
+ rectangle(PointInterface $leftTop, PointInterface $rightBottom, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.

+
+
+
+
+ $this +
+
+ polygon(array $coordinates, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.

+
+
+
+
+ $this +
+
+ text(string $string, AbstractFont $font, PointInterface $position, int $angle = 0, int $width = null) + +

Annotates image with specified text at a given position starting on the top left of the final text box.

+
+
+
+ + +

Details

+ +
+
+

+
at line 39
+ $this + arc(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, int $thickness = 1) + +

+
+ + + +
+

Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.

+
+

Parameters

+ +
- DrawerInterface - - arc(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, integer $thickness = 1) -

Draws an arc on a starting at a given x, y coordinates under a given start and end angles

-
- - + + - - + + - - + + - - + + - - + + - - + + +
- DrawerInterface - - chord(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Same as arc, but also connects end points with a straight line

- 		PointInterface$center
- DrawerInterface - - ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Draws and ellipse with center at the given x, y coordinates, and given width and height

- 		BoxInterface$size
- DrawerInterface - - line(PointInterface $start, PointInterface $end, ColorInterface $outline, integer $thickness = 1) -

Draws a line from start(x, y) to end(x, y) coordinates

- 		int$start
- DrawerInterface - - pieSlice(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Same as arc, but connects end points and the center

- 		int$end
- DrawerInterface - - dot(PointInterface $position, ColorInterface $color) -

Places a one pixel point at specific coordinates and fills it with specified color

- 		ColorInterface$color
- DrawerInterface - - polygon(array $coordinates, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Draws a polygon using array of x, y coordinates.

- 		int$thickness
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + - - +
- DrawerInterface - - text(string $string, AbstractFont $font, PointInterface $position, integer $angle, integer $width = null) -

Annotates image with specified text at a given position starting on the top left of the final text box

- 		RuntimeException
+ +
+
-

Details

- -

-
at line 40
- public DrawerInterface - arc(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, integer $thickness = 1) +

+
+

+
at line 56
+ $this + chord(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws an arc on a starting at a given x, y coordinates under a given start and end angles

-

-

-
+ + + +
+

Same as arc, but also connects end points with a straight line.

+

Parameters

- +
- + - + - + - + - + - + - + + + + + + - + - +
PointInterface $center -
BoxInterface $size -
integerint $start -
integerint $end -
ColorInterface $color -
bool$fill
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -199,82 +355,68 @@

Exceptions

-

-
at line 57
- public DrawerInterface - chord(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 71
+ $this + circle(PointInterface $center, int $radius, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Same as arc, but also connects end points with a straight line

-

-

-
+ + + +
+

Draws and circle with center at the given x, y coordinates, and given radius.

+

Parameters

- +
- - - - - - - - - - - + - - - + + + - + - + - + - + - +
PointInterface $center -
BoxInterface$size -
integer$start -
integer$end -int$radius
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -282,70 +424,68 @@

Exceptions

-

-
at line 73
- public DrawerInterface - ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 86
+ $this + ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws and ellipse with center at the given x, y coordinates, and given width and height

-

-

-
+ + + +
+

Draws and ellipse with center at the given x, y coordinates, and given width and height.

+

Parameters

- +
- + - + - + - + - + - + - +
PointInterface $center -
BoxInterface $size -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -353,53 +493,53 @@

Exceptions

-

-
at line 85
- public DrawerInterface - line(PointInterface $start, PointInterface $end, ColorInterface $outline, integer $thickness = 1) +

+
+

+
at line 98
+ $this + line(PointInterface $start, PointInterface $end, ColorInterface $outline, int $thickness = 1) +

-

Draws a line from start(x, y) to end(x, y) coordinates

-

-

-
+ + + +
+

Draws a line from start(x, y) to end(x, y) coordinates.

+

Parameters

- +
- + - + - + - + - +
PointInterface $start -
PointInterface $end -
ColorInterface $outline -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this
@@ -408,82 +548,78 @@

Return Value

-

-
at line 102
- public DrawerInterface - pieSlice(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 115
+ $this + pieSlice(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Same as arc, but connects end points and the center

-

-

-
+ + + +
+

Same as arc, but connects end points and the center.

+

Parameters

- +
- + - + - + - + - + - + - + - + - + - + - +
PointInterface $center -
BoxInterface $size -
integerint $start -
integerint $end -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -491,52 +627,54 @@

Exceptions

-

-
at line 115
- public DrawerInterface - dot(PointInterface $position, ColorInterface $color) +

+
+

+
at line 128
+ $this + dot(PointInterface $position, ColorInterface $color) +

-

Places a one pixel point at specific coordinates and fills it with specified color

-

-

-
+ + + +
+

Places a one pixel point at specific coordinates and fills it with +specified color.

+

Parameters

- +
- + - +
PointInterface $position -
ColorInterface $color -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -544,64 +682,132 @@

Exceptions

-

-
at line 130
- public DrawerInterface - polygon(array $coordinates, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 143
+ $this + rectangle(PointInterface $leftTop, PointInterface $rightBottom, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws a polygon using array of x, y coordinates.

-

Must contain at least -three coordinates

-
+ + + +
+

Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.

+

Parameters

- +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
PointInterface$leftTop
PointInterface$rightBottom
ColorInterface$color
bool$fill
int$thickness
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +
+
+ +
+
+

+
at line 157
+ $this + polygon(array $coordinates, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

+
+ + + +
+

Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.

+
+

Parameters

+ + - + - + - + - + - + - +
array $coordinates -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -609,69 +815,68 @@

Exceptions

-

-
at line 148
- public DrawerInterface - text(string $string, AbstractFont $font, PointInterface $position, integer $angle, integer $width = null) +

+
+

+
at line 174
+ $this + text(string $string, AbstractFont $font, PointInterface $position, int $angle = 0, int $width = null) +

-

Annotates image with specified text at a given position starting on the top left of the final text box

-

The rotation is done CW

-
+ + + +
+

Annotates image with specified text at a given position starting on the top left of the final text box.

The rotation is done CW

+

Parameters

- +
- + - + - + - + - + - + - +
string $string -
AbstractFont $font -
PointInterface $position -
integerint $angle -
integerint $width -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -679,10 +884,17 @@

Exceptions

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Draw/namespace-frame.html b/docs/API/API/Imagine/Draw/namespace-frame.html deleted file mode 100644 index d8c741704..000000000 --- a/docs/API/API/Imagine/Draw/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Draw | - - - diff --git a/docs/API/API/Imagine/Effects.html b/docs/API/API/Imagine/Effects.html index a08e14798..83bfaa26f 100644 --- a/docs/API/API/Imagine/Effects.html +++ b/docs/API/API/Imagine/Effects.html @@ -1,40 +1,104 @@ - - - - Imagine\Effects | - - - -
- - -
- -
Namespace
-

Imagine\Effects

+ + + + Imagine\Effects | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Effects
  5. \
    6. +
-
+
+
+

Imagine\Effects

+
+ + +

Interfaces

- - - - - -
EffectsInterfaceInterface for the effects
+ +
+
+
+ EffectsInterface + +
+
+ Interface for the effects. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Effects/EffectsInterface.html b/docs/API/API/Imagine/Effects/EffectsInterface.html index e233b03b7..ff10fe2b7 100644 --- a/docs/API/API/Imagine/Effects/EffectsInterface.html +++ b/docs/API/API/Imagine/Effects/EffectsInterface.html @@ -1,147 +1,226 @@ - - - - Imagine\Effects\EffectsInterface | - - - -
- - -
- -
Interface
-

Imagine\Effects\EffectsInterface

+ + + + Imagine\Effects\EffectsInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

interface - EffectsInterface

-
-

Interface for the effects

-

-

+
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Effects
  5. \
  6. EffectsInterface
    7. +
+
+ +
+

+ EffectsInterface + +

+
+ +

interface + EffectsInterface +

+ + + + +
+

Interface for the effects.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- EffectsInterface - +
+
+
+ $this +
+
gamma(float $correction) -

Apply gamma correction

-
- EffectsInterface - + +

Apply gamma correction.

+
+ +
+
+ $this +
+
negative() -

Invert the colors of the image

-
- EffectsInterface - + +

Invert the colors of the image.

+
+ +
+
+ $this +
+
grayscale() -

Grayscale the image

-
- EffectsInterface - + +

Grayscale the image.

+
+ +
+
+ $this +
+
colorize(ColorInterface $color) -

Colorize the image

-
- EffectsInterface - + +

Colorize the image.

+
+ +
+
+ $this +
+
sharpen() -

Sharpens the image

-
- EffectsInterface - + +

Sharpens the image.

+
+ +
+
+ $this +
+
blur(float|int $sigma) -

Blur the image

-
+ +

Blur the image.

+
+
+
+
+ $this +
+
+ brightness(int $brightness) + +

Changes the brightness of the image.

+
+
+
+
+ $this +
+
+ convolve(Matrix $matrix) + +

Convolves the image.

+
+
+

Details

-

-
at line 30
- public EffectsInterface - gamma(float $correction) +
+
+

+
at line 31
+ $this + gamma(float $correction) +

-

Apply gamma correction

-

-

-
+ + + +
+

Apply gamma correction.

+

Parameters

- +
- +
float $correction -

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -149,35 +228,38 @@

Exceptions

-

-
at line 39
- public EffectsInterface - negative() +

+
+

+
at line 40
+ $this + negative() +

-

Invert the colors of the image

-

-

-
+ + + +
+

Invert the colors of the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -185,35 +267,38 @@

Exceptions

-

-
at line 48
- public EffectsInterface - grayscale() +

+
+

+
at line 49
+ $this + grayscale() +

-

Grayscale the image

-

-

-
+ + + +
+

Grayscale the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -221,46 +306,48 @@

Exceptions

-

-
at line 59
- public EffectsInterface - colorize(ColorInterface $color) +

+
+

+
at line 60
+ $this + colorize(ColorInterface $color) +

-

Colorize the image

-

-

-
+ + + +
+

Colorize the image.

+

Parameters

- +
- +
ColorInterface $color -

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -268,35 +355,38 @@

Exceptions

-

-
at line 68
- public EffectsInterface - sharpen() +

+
+

+
at line 69
+ $this + sharpen() +

-

Sharpens the image

-

-

-
+ + + +
+

Sharpens the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -304,46 +394,146 @@

Exceptions

-

-
at line 79
- public EffectsInterface - blur(float|int $sigma) +

+
+

+
at line 80
+ $this + blur(float|int $sigma) +

-

Blur the image

-

-

-
+ + + +
+

Blur the image.

+

Parameters

- +
- + + +
float|int $sigma -
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +
+
+ +
+
+

+
at line 91
+ $this + brightness(int $brightness) + +

+
+ + + +
+

Changes the brightness of the image.

+
+

Parameters

+ + + + + + + +
int$brightnessThe level of brightness (-100 (black) to 100 (white))
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +
+
+ +
+
+

+
at line 102
+ $this + convolve(Matrix $matrix) + +

+
+ + + +
+

Convolves the image.

+
+

Parameters

+ + + + + +
Matrix$matrixThe matrix from which derive the convolution kernel

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -351,10 +541,17 @@

Exceptions

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Effects/namespace-frame.html b/docs/API/API/Imagine/Effects/namespace-frame.html deleted file mode 100644 index 2809833c1..000000000 --- a/docs/API/API/Imagine/Effects/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Effects | - - - diff --git a/docs/API/API/Imagine/Exception.html b/docs/API/API/Imagine/Exception.html index dca9a276d..b78f01c18 100644 --- a/docs/API/API/Imagine/Exception.html +++ b/docs/API/API/Imagine/Exception.html @@ -1,58 +1,144 @@ - - - - Imagine\Exception | - - - -
- - -
- -
Namespace
-

Imagine\Exception

+ + + + Imagine\Exception | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Exception
  5. \
    6. +
+
+
+ +
+

Imagine\Exception

-
- - - - - - - - - - - - - - - - - -
InvalidArgumentExceptionImagine-specific invalid argument exception
NotSupportedExceptionShould be used when a driver does not support an operation.
OutOfBoundsExceptionImagine-specific out of bounds exception
RuntimeExceptionImagine-specific runtime exception
+ + +

Classes

+ +
+
+
+ InvalidArgumentException + +
+
+ Imagine-specific invalid argument exception. +
+
+
+
+ NotSupportedException + +
+
+ Should be used when a driver does not support an operation. +
+
+
+
+ OutOfBoundsException + +
+
+ Imagine-specific out of bounds exception. +
+
+
+
+ RuntimeException + +
+
+ Imagine-specific runtime exception. +
+
+

Interfaces

- - - - - -
ExceptionImagine-specific exception
+ +
+
+
+ Exception + +
+
+ Imagine-specific exception. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Exception/Exception.html b/docs/API/API/Imagine/Exception/Exception.html index 4974a141a..8179e217a 100644 --- a/docs/API/API/Imagine/Exception/Exception.html +++ b/docs/API/API/Imagine/Exception/Exception.html @@ -1,42 +1,104 @@ - - - - Imagine\Exception\Exception | - - - -
- - -
- -
Interface
-

Imagine\Exception\Exception

+ + + + Imagine\Exception\Exception | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

interface - Exception

-
-

Imagine-specific exception

-

-

+
+
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Exception
  5. \
  6. Exception
    7. +
+
+
+ +
+

+ Exception + +

+
+ +

interface + Exception +

+ + + + +
+

Imagine-specific exception.

+ +
-
+ diff --git a/docs/API/API/Imagine/Exception/InvalidArgumentException.html b/docs/API/API/Imagine/Exception/InvalidArgumentException.html index d7472a389..36043b79e 100644 --- a/docs/API/API/Imagine/Exception/InvalidArgumentException.html +++ b/docs/API/API/Imagine/Exception/InvalidArgumentException.html @@ -1,43 +1,105 @@ - - - - Imagine\Exception\InvalidArgumentException | - - - -
- - -
- -
Class
-

Imagine\Exception\InvalidArgumentException

+ + + + Imagine\Exception\InvalidArgumentException | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - InvalidArgumentException extends InvalidArgumentException implements - Exception

-
-

Imagine-specific invalid argument exception

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Exception
  5. \
  6. InvalidArgumentException
    7. +
+
+
+ +
+

+ InvalidArgumentException + +

+
+ +

class + InvalidArgumentException extends InvalidArgumentException implements + Exception +

+ + + + +
+

Imagine-specific invalid argument exception.

+ +
-
+ diff --git a/docs/API/API/Imagine/Exception/NotSupportedException.html b/docs/API/API/Imagine/Exception/NotSupportedException.html index 91fb95c6d..f137681ef 100644 --- a/docs/API/API/Imagine/Exception/NotSupportedException.html +++ b/docs/API/API/Imagine/Exception/NotSupportedException.html @@ -1,43 +1,105 @@ - - - - Imagine\Exception\NotSupportedException | - - - -
- - -
- -
Class
-

Imagine\Exception\NotSupportedException

+ + + + Imagine\Exception\NotSupportedException | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Exception
  5. \
  6. NotSupportedException
    7. +
+
+
+ +
+

+ NotSupportedException + +

-
-

class + +

class NotSupportedException extends RuntimeException implements - Exception

+ Exception +

+ + +
-

Should be used when a driver does not support an operation.

-

-

-
+

Should be used when a driver does not support an operation.

+ +
-
+ diff --git a/docs/API/API/Imagine/Exception/OutOfBoundsException.html b/docs/API/API/Imagine/Exception/OutOfBoundsException.html index 2fa1d5a9f..5290fa314 100644 --- a/docs/API/API/Imagine/Exception/OutOfBoundsException.html +++ b/docs/API/API/Imagine/Exception/OutOfBoundsException.html @@ -1,43 +1,105 @@ - - - - Imagine\Exception\OutOfBoundsException | - - - -
- - -
- -
Class
-

Imagine\Exception\OutOfBoundsException

+ + + + Imagine\Exception\OutOfBoundsException | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - OutOfBoundsException extends OutOfBoundsException implements - Exception

-
-

Imagine-specific out of bounds exception

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Exception
  5. \
  6. OutOfBoundsException
    7. +
+
+
+ +
+

+ OutOfBoundsException + +

+
+ +

class + OutOfBoundsException extends OutOfBoundsException implements + Exception +

+ + + + +
+

Imagine-specific out of bounds exception.

+ +
-
+ diff --git a/docs/API/API/Imagine/Exception/RuntimeException.html b/docs/API/API/Imagine/Exception/RuntimeException.html index 2dc959d5b..57e8b2ce7 100644 --- a/docs/API/API/Imagine/Exception/RuntimeException.html +++ b/docs/API/API/Imagine/Exception/RuntimeException.html @@ -1,43 +1,105 @@ - - - - Imagine\Exception\RuntimeException | - - - -
- - -
- -
Class
-

Imagine\Exception\RuntimeException

+ + + + Imagine\Exception\RuntimeException | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - RuntimeException extends RuntimeException implements - Exception

-
-

Imagine-specific runtime exception

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Exception
  5. \
  6. RuntimeException
    7. +
+
+
+ +
+

+ RuntimeException + +

+
+ +

class + RuntimeException extends RuntimeException implements + Exception +

+ + + + +
+

Imagine-specific runtime exception.

+ +
-
+ diff --git a/docs/API/API/Imagine/Exception/namespace-frame.html b/docs/API/API/Imagine/Exception/namespace-frame.html deleted file mode 100644 index c26446ec5..000000000 --- a/docs/API/API/Imagine/Exception/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Exception | - - - diff --git a/docs/API/API/Imagine/Factory.html b/docs/API/API/Imagine/Factory.html new file mode 100644 index 000000000..94d8312a2 --- /dev/null +++ b/docs/API/API/Imagine/Factory.html @@ -0,0 +1,126 @@ + + + + + + Imagine\Factory | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Factory
  5. \
    6. +
+
+
+ +
+

Imagine\Factory

+
+ + +

Classes

+ +
+
+
+ ClassFactory + +
+
+ The default implementation of Imagine\Factory\ClassFactoryInterface. +
+
+
+ +

Interfaces

+ +
+
+
+ ClassFactoryAwareInterface + +
+
+ An interface that classes that accepts a class factory should implement. +
+
+
+
+ ClassFactoryInterface + +
+
+ The interface that class factories must implement. +
+
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Factory/ClassFactory.html b/docs/API/API/Imagine/Factory/ClassFactory.html new file mode 100644 index 000000000..7acb2ee3a --- /dev/null +++ b/docs/API/API/Imagine/Factory/ClassFactory.html @@ -0,0 +1,738 @@ + + + + + + Imagine\Factory\ClassFactory | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Factory
  5. \
  6. ClassFactory
    7. +
+
+
+ +
+

+ ClassFactory + +

+
+ +

class + ClassFactory implements + ClassFactoryInterface +

+ + + + +
+

The default implementation of Imagine\Factory\ClassFactoryInterface.

+ + + + +

Methods

+ +
+
+
+ MetadataReaderInterface +
+
+ createMetadataReader() + +

Create a new instance of a metadata reader.

+
+
+
+
+ BoxInterface +
+
+ createBox(int $width, int $height) + +

Create new BoxInterface instance.

+
+
+
+
+ LoaderInterface +
+
+ createFileLoader(string|mixed $path) + +

Create a new instance of a file loader.

+
+
+
+
+ DrawerInterface +
+
+ createDrawer(string $handle, mixed $resource) + +

Create a new DrawerInterface instance.

+
+
+
+
+ LayersInterface +
+
+ createLayers(string $handle, ImageInterface $image, mixed|null $initialKey = null) + +

Crate a new instance of a layers interface.

+
+
+
+
+ EffectsInterface +
+
+ createEffects(string $handle, mixed $resource) + +

Create a new EffectsInterface instance.

+
+
+
+
+ ImageInterface +
+
+ createImage(string $handle, mixed $resource, PaletteInterface $palette, MetadataBag $metadata) + +

Create a new ImageInterface instance.

+
+
+
+
+ FontInterface +
+
+ createFont(string $handle, string $file, int $size, ColorInterface $color) + +

Create new FontInterface instance.

+
+
+
+
+ object +
+
+ finalize(object $object) + +

Finalize the newly created object.

+
+
+
+
+ static array +
+
+ getGDInfo() + +

No description

+
+
+
+
+ + +

Details

+ +
+
+

+
at line 31
+ MetadataReaderInterface + createMetadataReader() + +

+
+ + + +
+

Create a new instance of a metadata reader.

+
+ +

Return Value

+ + + + + + +
MetadataReaderInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryInterface::createMetadataReader +
+ +
+
+ +
+
+

+
at line 41
+ BoxInterface + createBox(int $width, int $height) + +

+
+ + + +
+

Create new BoxInterface instance.

+
+

Parameters

+ + + + + + + + + + + + +
int$widthThe box width
int$heightThe box height
+ + +

Return Value

+ + + + + + +
BoxInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryInterface::createBox +
+ +
+
+ +
+
+

+
at line 51
+ LoaderInterface + createFileLoader(string|mixed $path) + +

+
+ + + +
+

Create a new instance of a file loader.

+
+

Parameters

+ + + + + + + +
string|mixed$path
+ + +

Return Value

+ + + + + + +
LoaderInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryInterface::createFileLoader +
+ +
+
+ +
+
+

+
at line 61
+ DrawerInterface + createDrawer(string $handle, mixed $resource) + +

+
+ + + +
+

Create a new DrawerInterface instance.

+
+

Parameters

+ + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
mixed$resource
+ + +

Return Value

+ + + + + + +
DrawerInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryInterface::createDrawer +
+ +
+
+ +
+
+

+
at line 80
+ LayersInterface + createLayers(string $handle, ImageInterface $image, mixed|null $initialKey = null) + +

+
+ + + +
+

Crate a new instance of a layers interface.

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
ImageInterface$image
mixed|null$initialKeythe key of the initially selected layer
+ + +

Return Value

+ + + + + + +
LayersInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryInterface::createLayers +
+ +
+
+ +
+
+

+
at line 99
+ EffectsInterface + createEffects(string $handle, mixed $resource) + +

+
+ + + +
+

Create a new EffectsInterface instance.

+
+

Parameters

+ + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
mixed$resource
+ + +

Return Value

+ + + + + + +
EffectsInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryInterface::createEffects +
+ +
+
+ +
+
+

+
at line 118
+ ImageInterface + createImage(string $handle, mixed $resource, PaletteInterface $palette, MetadataBag $metadata) + +

+
+ + + +
+

Create a new ImageInterface instance.

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
mixed$resource
PaletteInterface$palette
MetadataBag$metadata
+ + +

Return Value

+ + + + + + +
ImageInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryInterface::createImage +
+ +
+
+ +
+
+

+
at line 137
+ FontInterface + createFont(string $handle, string $file, int $size, ColorInterface $color) + +

+
+ + + +
+

Create new FontInterface instance.

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
string$file
int$sizethe font size in points (e.g. 10pt means 10)
ColorInterface$color
+ + +

Return Value

+ + + + + + +
FontInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryInterface::createFont +
+ +
+
+ +
+
+

+
at line 166
+ protected object + finalize(object $object) + +

+
+ + + +
+

Finalize the newly created object.

+
+

Parameters

+ + + + + + + +
object$object
+ + +

Return Value

+ + + + + + +
object
+ + + +
+
+ +
+
+

+
at line 178
+ static protected array + getGDInfo() + +

+
+ + + +
+ +

Return Value

+ + + + + + +
array
+ + + +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Factory/ClassFactoryAwareInterface.html b/docs/API/API/Imagine/Factory/ClassFactoryAwareInterface.html new file mode 100644 index 000000000..13a9261f6 --- /dev/null +++ b/docs/API/API/Imagine/Factory/ClassFactoryAwareInterface.html @@ -0,0 +1,205 @@ + + + + + + Imagine\Factory\ClassFactoryAwareInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Factory
  5. \
  6. ClassFactoryAwareInterface
    7. +
+
+
+ +
+

+ ClassFactoryAwareInterface + +

+
+ +

interface + ClassFactoryAwareInterface +

+ + + + +
+

An interface that classes that accepts a class factory should implement.

+ + + + +

Methods

+ +
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
+
+
+ + +

Details

+ +
+
+

+
at line 17
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +
+
+ +
+
+

+
at line 24
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+
+ +

Return Value

+ + + + + + +
ClassFactoryInterface
+ + + +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Factory/ClassFactoryInterface.html b/docs/API/API/Imagine/Factory/ClassFactoryInterface.html new file mode 100644 index 000000000..31145f15b --- /dev/null +++ b/docs/API/API/Imagine/Factory/ClassFactoryInterface.html @@ -0,0 +1,586 @@ + + + + + + Imagine\Factory\ClassFactoryInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Factory
  5. \
  6. ClassFactoryInterface
    7. +
+
+
+ +
+

+ ClassFactoryInterface + +

+
+ +

interface + ClassFactoryInterface +

+ + + + +
+

The interface that class factories must implement.

+ + +

Constants

+ + + + + + + + + + + + + + +
HANDLE_GD +

The handle to be used for the GD manipulation library.

+

+
HANDLE_GMAGICK +

The handle to be used for the Gmagick manipulation library.

+

+
HANDLE_IMAGICK +

The handle to be used for the Imagick manipulation library.

+

+
+ + + +

Methods

+ +
+
+
+ MetadataReaderInterface +
+
+ createMetadataReader() + +

Create a new instance of a metadata reader.

+
+
+
+
+ BoxInterface +
+
+ createBox(int $width, int $height) + +

Create new BoxInterface instance.

+
+
+
+
+ FontInterface +
+
+ createFont(string $handle, string $file, int $size, ColorInterface $color) + +

Create new FontInterface instance.

+
+
+
+
+ LoaderInterface +
+
+ createFileLoader(string|mixed $path) + +

Create a new instance of a file loader.

+
+
+
+
+ LayersInterface +
+
+ createLayers(string $handle, ImageInterface $image, mixed|null $initialKey = null) + +

Crate a new instance of a layers interface.

+
+
+
+
+ ImageInterface +
+
+ createImage(string $handle, mixed $resource, PaletteInterface $palette, MetadataBag $metadata) + +

Create a new ImageInterface instance.

+
+
+
+
+ DrawerInterface +
+
+ createDrawer(string $handle, mixed $resource) + +

Create a new DrawerInterface instance.

+
+
+
+
+ EffectsInterface +
+
+ createEffects(string $handle, mixed $resource) + +

Create a new EffectsInterface instance.

+
+
+
+ + +

Details

+ +
+
+

+
at line 38
+ MetadataReaderInterface + createMetadataReader() + +

+
+ + + +
+

Create a new instance of a metadata reader.

+
+ +

Return Value

+ + + + + + +
MetadataReaderInterface
+ + + +
+
+ +
+
+

+
at line 48
+ BoxInterface + createBox(int $width, int $height) + +

+
+ + + +
+

Create new BoxInterface instance.

+
+

Parameters

+ + + + + + + + + + + + +
int$widthThe box width
int$heightThe box height
+ + +

Return Value

+ + + + + + +
BoxInterface
+ + + +
+
+ +
+
+

+
at line 60
+ FontInterface + createFont(string $handle, string $file, int $size, ColorInterface $color) + +

+
+ + + +
+

Create new FontInterface instance.

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
string$file
int$sizethe font size in points (e.g. 10pt means 10)
ColorInterface$color
+ + +

Return Value

+ + + + + + +
FontInterface
+ + + +
+
+ +
+
+

+
at line 69
+ LoaderInterface + createFileLoader(string|mixed $path) + +

+
+ + + +
+

Create a new instance of a file loader.

+
+

Parameters

+ + + + + + + +
string|mixed$path
+ + +

Return Value

+ + + + + + +
LoaderInterface
+ + + +
+
+ +
+
+

+
at line 80
+ LayersInterface + createLayers(string $handle, ImageInterface $image, mixed|null $initialKey = null) + +

+
+ + + +
+

Crate a new instance of a layers interface.

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
ImageInterface$image
mixed|null$initialKeythe key of the initially selected layer
+ + +

Return Value

+ + + + + + +
LayersInterface
+ + + +
+
+ +
+
+

+
at line 92
+ ImageInterface + createImage(string $handle, mixed $resource, PaletteInterface $palette, MetadataBag $metadata) + +

+
+ + + +
+

Create a new ImageInterface instance.

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
mixed$resource
PaletteInterface$palette
MetadataBag$metadata
+ + +

Return Value

+ + + + + + +
ImageInterface
+ + + +
+
+ +
+
+

+
at line 102
+ DrawerInterface + createDrawer(string $handle, mixed $resource) + +

+
+ + + +
+

Create a new DrawerInterface instance.

+
+

Parameters

+ + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
mixed$resource
+ + +

Return Value

+ + + + + + +
DrawerInterface
+ + + +
+
+ +
+
+

+
at line 112
+ EffectsInterface + createEffects(string $handle, mixed $resource) + +

+
+ + + +
+

Create a new EffectsInterface instance.

+
+

Parameters

+ + + + + + + + + + + + +
string$handleThe handle that identifies the manipulation library (one of the HANDLE_... constants, or your own implementation).
mixed$resource
+ + +

Return Value

+ + + + + + +
EffectsInterface
+ + + +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/File.html b/docs/API/API/Imagine/File.html new file mode 100644 index 000000000..5a994cbae --- /dev/null +++ b/docs/API/API/Imagine/File.html @@ -0,0 +1,117 @@ + + + + + + Imagine\File | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. File
  5. \
    6. +
+
+
+ +
+

Imagine\File

+
+ + +

Classes

+ +
+
+
+ Loader + +
+
+ Default implementation of Imagine\File\LoaderInterface. +
+
+
+ +

Interfaces

+ +
+
+
+ LoaderInterface + +
+
+ Interface for classes that can load local or remote files. +
+
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/File/Loader.html b/docs/API/API/Imagine/File/Loader.html new file mode 100644 index 000000000..16b4df240 --- /dev/null +++ b/docs/API/API/Imagine/File/Loader.html @@ -0,0 +1,800 @@ + + + + + + Imagine\File\Loader | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. File
  5. \
  6. Loader
    7. +
+
+
+ +
+

+ Loader + +

+
+ +

class + Loader implements + LoaderInterface +

+ + + + +
+

Default implementation of Imagine\File\LoaderInterface.

+ + +

Constants

+ + + + + + +
MINIMUM_CURL_VERSION +

The mimimum supported version of curl.

+

+
+ + +

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ protected string + $pathThe file path.
+ protected bool + $isUrlDoes $path contain an URL?
+ protected string|null + $dataThe loaded data.
+ protected bool|null + $isCurlSupportedIs curl available, with a decent version?
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(string|mixed $path) + +

Initialize the instance.

+
+
+
+
+ bool +
+
+ isLocalFile() + +

Is this a local file.

+
+
+
+
+ string +
+
+ getPath() + +

Get the path of the file (local or remote).

+
+
+
+
+ bool +
+
+ hasReadData() + +

Is the binary content already loaded?

+
+
+
+
+ string +
+
+ getData() + +

Get the file binary contents.

+
+
+
+
+ string +
+
+ __toString() + +

The string representation of this object must be the file path (local or remote).

+
+
+
+
+ string +
+
+ readLocalFile() + +

Read a local file.

+
+
+
+
+ +
+
+ checkLocalFile() + +

Check that the file exists and it's readable.

+
+
+
+
+ string +
+
+ readRemoteFile() + +

Read a remote file.

+
+
+
+
+ bool +
+
+ isCurlSupported() + +

Check if curl is available and it's a decent version.

+
+
+
+
+ string +
+
+ readRemoteFileWithCurl() + +

Read a remote file using the cURL extension.

+
+
+
+
+ +
+
+ setCurlOptions(resource $curl) + +

Set curl options.

+
+
+
+
+ string +
+
+ readRemoteFileWithFileGetContents() + +

Read a remote file using the file_get_contents.

+
+
+
+ + +

Details

+ +
+
+

+
at line 61
+ + __construct(string|mixed $path) + +

+
+ + + +
+

Initialize the instance.

+
+

Parameters

+ + + + + + + +
string|mixed$paththe file path (or an object whose string representation is the file path)
+ + + +

Exceptions

+ + + + + + +
InvalidArgumentExceptionthrows an InvalidArgumentException is $path is an empty string, or is not an object that has a __toString method
+ + +
+
+ +
+
+

+
at line 82
+ bool + isLocalFile() + +

+
+ + + +
+

Is this a local file.

+
+ +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + + + +
+ LoaderInterface::isLocalFile +
+ +
+
+ +
+
+

+
at line 92
+ string + getPath() + +

+
+ + + +
+

Get the path of the file (local or remote).

+
+ +

Return Value

+ + + + + + +
string
+ + + +

See also

+ + + + + + +
+ LoaderInterface::getPath +
+ +
+
+ +
+
+

+
at line 102
+ bool + hasReadData() + +

+
+ + + +
+

Is the binary content already loaded?

+
+ +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + + + +
+ LoaderInterface::hasReadData +
+ +
+
+ +
+
+

+
at line 115
+ string + getData() + +

+
+ + + +
+

Get the file binary contents.

+
+ +

Return Value

+ + + + + + +
string
+ + + +

See also

+ + + + + + +
+ LoaderInterface::getData +
+ +
+
+ +
+
+

+
at line 133
+ string + __toString() + +

+
+ + + +
+

The string representation of this object must be the file path (local or remote).

+
+ +

Return Value

+ + + + + + +
string
+ + + +

See also

+ + + + + + +
+ LoaderInterface::__toString +
+ +
+
+ +
+
+

+
at line 145
+ protected string + readLocalFile() + +

+
+ + + +
+

Read a local file.

+
+ +

Return Value

+ + + + + + +
string
+ + +

Exceptions

+ + + + + + +
InvalidArgumentException
+ + +
+
+ +
+
+

+
at line 161
+ protected + checkLocalFile() + +

+
+ + + +
+

Check that the file exists and it's readable.

+
+ + +

Exceptions

+ + + + + + +
InvalidArgumentException
+ + +
+
+ +
+
+

+
at line 179
+ protected string + readRemoteFile() + +

+
+ + + +
+

Read a remote file.

+
+ +

Return Value

+ + + + + + +
string
+ + +

Exceptions

+ + + + + + + + + + +
InvalidArgumentException
RuntimeException
+ + +
+
+ +
+
+

+
at line 193
+ protected bool + isCurlSupported() + +

+
+ + + +
+

Check if curl is available and it's a decent version.

+
+ +

Return Value

+ + + + + + +
bool
+ + + +
+
+ +
+
+

+
at line 218
+ protected string + readRemoteFileWithCurl() + +

+
+ + + +
+

Read a remote file using the cURL extension.

+
+ +

Return Value

+ + + + + + +
string
+ + +

Exceptions

+ + + + + + +
InvalidArgumentException
+ + +
+
+ +
+
+

+
at line 259
+ protected + setCurlOptions(resource $curl) + +

+
+ + + +
+

Set curl options.

+
+

Parameters

+ + + + + + + +
resource$curl
+ + + +

Exceptions

+ + + + + + +
RuntimeException
+ + +
+
+ +
+
+

+
at line 287
+ protected string + readRemoteFileWithFileGetContents() + +

+
+ + + +
+

Read a remote file using the file_get_contents.

+
+ +

Return Value

+ + + + + + +
string
+ + +

Exceptions

+ + + + + + +
InvalidArgumentException
+ + +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/File/LoaderInterface.html b/docs/API/API/Imagine/File/LoaderInterface.html new file mode 100644 index 000000000..c820ff9a8 --- /dev/null +++ b/docs/API/API/Imagine/File/LoaderInterface.html @@ -0,0 +1,315 @@ + + + + + + Imagine\File\LoaderInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. File
  5. \
  6. LoaderInterface
    7. +
+
+
+ +
+

+ LoaderInterface + +

+
+ +

interface + LoaderInterface +

+ + + + +
+

Interface for classes that can load local or remote files.

+ + + + +

Methods

+ +
+
+
+ bool +
+
+ isLocalFile() + +

Is this a local file.

+
+
+
+
+ string +
+
+ getPath() + +

Get the path of the file (local or remote).

+
+
+
+
+ bool +
+
+ hasReadData() + +

Is the binary content already loaded?

+
+
+
+
+ string +
+
+ getData() + +

Get the file binary contents.

+
+
+
+
+ string +
+
+ __toString() + +

The string representation of this object must be the file path (local or remote).

+
+
+
+ + +

Details

+ +
+
+

+
at line 21
+ bool + isLocalFile() + +

+
+ + + +
+

Is this a local file.

+
+ +

Return Value

+ + + + + + +
bool
+ + + +
+
+ +
+
+

+
at line 28
+ string + getPath() + +

+
+ + + +
+

Get the path of the file (local or remote).

+
+ +

Return Value

+ + + + + + +
string
+ + + +
+
+ +
+
+

+
at line 35
+ bool + hasReadData() + +

+
+ + + +
+

Is the binary content already loaded?

+
+ +

Return Value

+ + + + + + +
bool
+ + + +
+
+ +
+
+

+
at line 42
+ string + getData() + +

+
+ + + +
+

Get the file binary contents.

+
+ +

Return Value

+ + + + + + +
string
+ + + +
+
+ +
+
+

+
at line 49
+ string + __toString() + +

+
+ + + +
+

The string representation of this object must be the file path (local or remote).

+
+ +

Return Value

+ + + + + + +
string
+ + + +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Filter.html b/docs/API/API/Imagine/Filter.html index 94cfaa754..bba54b5e0 100644 --- a/docs/API/API/Imagine/Filter.html +++ b/docs/API/API/Imagine/Filter.html @@ -1,50 +1,129 @@ - - - - Imagine\Filter | - - - -
- - -
- -
Namespace
-

Imagine\Filter

+ + + + Imagine\Filter | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
    6. +
+
+
+ +
+

Imagine\Filter

-
- - - - - - - - - -
ImagineAwareImagineAware base class
TransformationA transformation filter
+ +

Namespaces

+
+ Imagine\Filter\AdvancedImagine\Filter\Basic
+ +

Classes

+ +
+
+
+ ImagineAware + +
+
+ ImagineAware base class. +
+
+
+
+ Transformation + +
+
+ A transformation filter. +
+
+

Interfaces

- - - - - -
FilterInterfaceInterface for imagine filters
+ +
+
+
+ FilterInterface + +
+
+ Interface for imagine filters. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Advanced.html b/docs/API/API/Imagine/Filter/Advanced.html index 774bf097e..bae3409dd 100644 --- a/docs/API/API/Imagine/Filter/Advanced.html +++ b/docs/API/API/Imagine/Filter/Advanced.html @@ -1,55 +1,177 @@ - - - - Imagine\Filter\Advanced | - - - -
- - -
- -
Namespace
-

Imagine\Filter\Advanced

+ + + + Imagine\Filter\Advanced | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
    8. +
+
+
+ +
+

Imagine\Filter\Advanced

-
- - - - - - - - - - - - - - - - - - - - - -
BorderA border filter
CanvasA canvas filter
GrayscaleThe Grayscale filter calculates the gray-value based on RGB.
OnPixelBasedThe OnPixelBased takes a callable, and for each pixel, this callable is called with the image (\Imagine\Image\ImageInterface) and the current point (\Imagine\Image\Point)
RelativeResizeThe RelativeResize filter allows images to be resized relative to their existing dimensions.
+ + +

Classes

+ +
+
+
+ BlackWhite + +
+
+ This filter calculates, for each pixel of an image, whether it is ligher or darker than a threshold. +
+
+
+
+ Border + +
+
+ A border filter. +
+
+
+
+ BorderDetection + +
+
+ BorderDetection based on Laplace-Operator. Three different variants are offered:. +
+
+
+
+ Canvas + +
+
+ A canvas filter. +
+
+
+
+ Grayscale + +
+
+ The Grayscale filter calculates the gray-value based on RGB. +
+
+
+
+ Negation + +
+
+ This filter negates every color of every pixel of an image. +
+
+
+
+ Neighborhood + +
+
+ The Neighborhood filter takes a matrix and calculates the color current pixel based on its neighborhood. +
+
+
+
+ OnPixelBased + +
+
+ The OnPixelBased takes a callable, and for each pixel, this callable is called with the +image (\Imagine\Image\ImageInterface) and the current point (\Imagine\Image\Point). +
+
+
+
+ RelativeResize + +
+
+ The RelativeResize filter allows images to be resized relative to their existing dimensions. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Advanced/BlackWhite.html b/docs/API/API/Imagine/Filter/Advanced/BlackWhite.html new file mode 100644 index 000000000..c93be1d06 --- /dev/null +++ b/docs/API/API/Imagine/Filter/Advanced/BlackWhite.html @@ -0,0 +1,249 @@ + + + + + + Imagine\Filter\Advanced\BlackWhite | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
  8. BlackWhite
    9. +
+
+
+ +
+

+ BlackWhite + +

+
+ +

class + BlackWhite extends OnPixelBased implements + FilterInterface +

+ + + + +
+

This filter calculates, for each pixel of an image, whether it is ligher or darker than a threshold.

If the pixel is lighter than the thresold it will be black, otherwise it will be light. +The result is an image with only black and white pixels (black pixels for ligher colors, white pixels for darker colors).

+ + + +

Properties

+ + + + + + + + + + + + + + +
+ protected callable + $callbackfrom OnPixelBased
+ protected Grayscale + $grayScaleFilter
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(int $threshold) + +

Initialize this filter.

+
+
+
+
+ ImageInterface +
+
+ apply(ImageInterface $image) + +

Applies scheduled transformation to an ImageInterface instance.

+
+
+
+ + +

Details

+ +
+
+

+
at line 40
+ + __construct(int $threshold) + +

+
+ + + +
+

Initialize this filter.

+
+

Parameters

+ + + + + + + +
int$thresholdthe dask/light threshold, from 0 (all black) to 255 (all white)
+ + + +

Exceptions

+ + + + + + +
InvalidArgumentException
+ + +
+
+ +
+
+

+
at line 62
+ ImageInterface + apply(ImageInterface $image) + +

+
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+
+

Parameters

+ + + + + + + +
ImageInterface$image
+ + +

Return Value

+ + + + + + +
ImageInterfacereturns the processed ImageInterface instance
+ + + +

See also

+ + + + + + +
+ OnPixelBased::apply +
+ +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Filter/Advanced/Border.html b/docs/API/API/Imagine/Filter/Advanced/Border.html index bfc1b6a17..e6583c6e9 100644 --- a/docs/API/API/Imagine/Filter/Advanced/Border.html +++ b/docs/API/API/Imagine/Filter/Advanced/Border.html @@ -1,94 +1,155 @@ - - - - Imagine\Filter\Advanced\Border | - - - -
- + + + + Imagine\Filter\Advanced\Border | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
-
+
+
+ -
Class
-

Imagine\Filter\Advanced\Border

+
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
  8. Border
    9. +
+
+
+ +
+

+ Border + +

-
-

class + +

class Border implements - FilterInterface

+ FilterInterface +

+ + +
-

A border filter

-

-

-
+

A border filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
- __construct(ColorInterface $color, integer $width = 1, integer $height = 1) -

Constructs Border filter with given color, width and height

-
+ +
+ __construct(ColorInterface $color, int $width = 1, int $height = 1) + +

Constructs Border filter with given color, width and height.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 46
- public - __construct(ColorInterface $color, integer $width = 1, integer $height = 1) +
+
+

+
at line 46
+ + __construct(ColorInterface $color, int $width = 1, int $height = 1) +

-

Constructs Border filter with given color, width and height

-

-

-
+ + + +
+

Constructs Border filter with given color, width and height.

+

Parameters

- +
- + - + - + @@ -100,47 +161,68 @@

Parameters

-

-
at line 56
- public ImageInterface - apply(ImageInterface $image) + +
+

+
at line 58
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

-

ColorInterface $color -
integerint $width Width of the border on the left and right sides of the image
integerint $height Height of the border on the top and bottom sides of the image
+
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-

+ diff --git a/docs/API/API/Imagine/Filter/Advanced/BorderDetection.html b/docs/API/API/Imagine/Filter/Advanced/BorderDetection.html new file mode 100644 index 000000000..3fa1447e6 --- /dev/null +++ b/docs/API/API/Imagine/Filter/Advanced/BorderDetection.html @@ -0,0 +1,277 @@ + + + + + + Imagine\Filter\Advanced\BorderDetection | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
  8. BorderDetection
    9. +
+
+
+ +
+

+ BorderDetection + +

+
+ +

class + BorderDetection extends Neighborhood implements + FilterInterface +

+ + + + +
+

BorderDetection based on Laplace-Operator. Three different variants are offered:.

+ +
+  First          Second            Third
+ 0,  1, 0       1,  1, 1,       -1,  2, -1,
+ 1, -4, 1  and  1, -8, 1,  and   2, -4,  2,
+ 0,  1, 0       1,  1, 1        -1,  2, -1
+
+ +

.

+ +

Consider to apply this filter on a grayscaled image.

+ + +

Constants

+ + + + + + + + + + + + + + +
VARIANT_ONE +

First variant of the detection matrix.

+

+
VARIANT_TWO +

Second variant of the detection matrix.

+

+
VARIANT_THREE +

Third variant of the detection matrix.

+

+
+ + +

Properties

+ + + + + + + + +
+ protected Matrix + $matrixfrom Neighborhood
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(int $variant = self::VARIANT_ONE) + +

Initialize this filter.

+
+
+
+
+ ImageInterface +
+
+ apply(ImageInterface $image) + +

Applies scheduled transformation to an ImageInterface instance.

+
from Neighborhood
+
+
+ + +

Details

+ +
+
+

+
at line 59
+ + __construct(int $variant = self::VARIANT_ONE) + +

+
+ + + +
+

Initialize this filter.

+
+

Parameters

+ + + + + + + +
int$variantOne of the BorderDetection::VARIANT_... constants.
+ + + +

Exceptions

+ + + + + + +
InvalidArgumentExceptionthrows an InvalidArgumentException if $variant is not valid
+ + +
+
+ +
+
+

+
in Neighborhood at line 59
+ ImageInterface + apply(ImageInterface $image) + +

+
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+
+

Parameters

+ + + + + + + +
ImageInterface$image
+ + +

Return Value

+ + + + + + +
ImageInterfacereturns the processed ImageInterface instance
+ + + +

See also

+ + + + + + +
+ FilterInterface::apply +
+ +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Filter/Advanced/Canvas.html b/docs/API/API/Imagine/Filter/Advanced/Canvas.html index e5dc49e5d..ef6fcfe4e 100644 --- a/docs/API/API/Imagine/Filter/Advanced/Canvas.html +++ b/docs/API/API/Imagine/Filter/Advanced/Canvas.html @@ -1,104 +1,162 @@ - - - - Imagine\Filter\Advanced\Canvas | - - - -
- + + + + Imagine\Filter\Advanced\Canvas | Imagine API v1.2.5-dev + + + + + + + + + + + + + + -
+ +
+
+
+ +
+ + +
+
+ +
+ +
+
+ -
Class
-

Imagine\Filter\Advanced\Canvas

+
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
  8. Canvas
    9. +
+
+
+ +
+

+ Canvas + +

-
-

class + +

class Canvas implements - FilterInterface

+ FilterInterface +

+ + +
-

A canvas filter

-

-

-
+

A canvas filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
+ +
__construct(ImagineInterface $imagine, BoxInterface $size, PointInterface $placement = null, ColorInterface $background = null) -

Constructs Canvas filter with given width and height and the placement of the current image inside the new canvas

-
+ +

Constructs Canvas filter with given width and height and the placement of the current image inside the new canvas.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 56
- public - __construct(ImagineInterface $imagine, BoxInterface $size, PointInterface $placement = null, ColorInterface $background = null) +
+
+

+
at line 55
+ + __construct(ImagineInterface $imagine, BoxInterface $size, PointInterface $placement = null, ColorInterface $background = null) +

-

Constructs Canvas filter with given width and height and the placement of the current image inside the new canvas

-

-

-
+ + + +
+

Constructs Canvas filter with given width and height and the placement of the current image inside the new canvas.

+

Parameters

- +
- + - + - + - +
ImagineInterface $imagine -
BoxInterface $size -
PointInterface $placement -
ColorInterface $background -
@@ -108,47 +166,68 @@

Parameters

-

-
at line 67
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 68
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Advanced/Grayscale.html b/docs/API/API/Imagine/Filter/Advanced/Grayscale.html index 3d68b0af1..4abb92cb7 100644 --- a/docs/API/API/Imagine/Filter/Advanced/Grayscale.html +++ b/docs/API/API/Imagine/Filter/Advanced/Grayscale.html @@ -1,127 +1,230 @@ - - - - Imagine\Filter\Advanced\Grayscale | - - - -
- + + + + Imagine\Filter\Advanced\Grayscale | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ -
Class
-

Imagine\Filter\Advanced\Grayscale

+
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
  8. Grayscale
    9. +
+
+
+ +
+

+ Grayscale + +

-
-

class + +

class Grayscale extends OnPixelBased implements - FilterInterface

+ FilterInterface +

+ + +
-

The Grayscale filter calculates the gray-value based on RGB.

-

-

-
+

The Grayscale filter calculates the gray-value based on RGB.

-

Methods

+

Properties

- +
- - - + + + - -
- - - __construct() -

-

+ 		+ protected callable $callbackfrom OnPixelBased
+
+ + +

Methods

+ +
+
+
+ +
+
+ __construct() + +

Initialize the instance.

+
+
+
+
ImageInterface - - +
+
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

- - from OnPixelBased - - + +

Applies scheduled transformation to an ImageInterface instance.

+
from OnPixelBased
+
+

Details

-

-
at line 23
- public - __construct() +
+
+

+
at line 23
+ + __construct() +

-

-

-

-

-
+ + +
+

Initialize the instance.

+
+

Exceptions

+ + + + + + +
InvalidArgumentException
+ +
-

-
in OnPixelBased at line 44
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
in OnPixelBased at line 51
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Advanced/Negation.html b/docs/API/API/Imagine/Filter/Advanced/Negation.html new file mode 100644 index 000000000..98f2f494c --- /dev/null +++ b/docs/API/API/Imagine/Filter/Advanced/Negation.html @@ -0,0 +1,177 @@ + + + + + + Imagine\Filter\Advanced\Negation | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
  8. Negation
    9. +
+
+
+ +
+

+ Negation + +

+
+ +

class + Negation implements + FilterInterface +

+ + + + +
+

This filter negates every color of every pixel of an image.

+ + + + +

Methods

+ +
+
+
+ ImageInterface +
+
+ apply(ImageInterface $image) + +

Applies scheduled transformation to an ImageInterface instance.

+
+
+
+ + +

Details

+ +
+
+

+
at line 27
+ ImageInterface + apply(ImageInterface $image) + +

+
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+
+

Parameters

+ + + + + + + +
ImageInterface$image
+ + +

Return Value

+ + + + + + +
ImageInterfacereturns the processed ImageInterface instance
+ + + +

See also

+ + + + + + +
+ FilterInterface::apply +
+ +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Filter/Advanced/Neighborhood.html b/docs/API/API/Imagine/Filter/Advanced/Neighborhood.html new file mode 100644 index 000000000..36f6a4418 --- /dev/null +++ b/docs/API/API/Imagine/Filter/Advanced/Neighborhood.html @@ -0,0 +1,231 @@ + + + + + + Imagine\Filter\Advanced\Neighborhood | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
  8. Neighborhood
    9. +
+
+
+ +
+

+ Neighborhood + +

+
+ +

class + Neighborhood implements + FilterInterface +

+ + + + +
+

The Neighborhood filter takes a matrix and calculates the color current pixel based on its neighborhood.

+ + + +

Properties

+ + + + + + + + +
+ protected Matrix + $matrix
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(Matrix $matrix) + +

Initialize the instance.

+
+
+
+
+ ImageInterface +
+
+ apply(ImageInterface $image) + +

Applies scheduled transformation to an ImageInterface instance.

+
+
+
+ + +

Details

+ +
+
+

+
at line 49
+ + __construct(Matrix $matrix) + +

+
+ + + +
+

Initialize the instance.

+
+

Parameters

+ + + + + + + +
Matrix$matrix
+ + + + +
+
+ +
+
+

+
at line 59
+ ImageInterface + apply(ImageInterface $image) + +

+
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+
+

Parameters

+ + + + + + + +
ImageInterface$image
+ + +

Return Value

+ + + + + + +
ImageInterfacereturns the processed ImageInterface instance
+ + + +

See also

+ + + + + + +
+ FilterInterface::apply +
+ +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Filter/Advanced/OnPixelBased.html b/docs/API/API/Imagine/Filter/Advanced/OnPixelBased.html index 7d4ad0f93..74658b677 100644 --- a/docs/API/API/Imagine/Filter/Advanced/OnPixelBased.html +++ b/docs/API/API/Imagine/Filter/Advanced/OnPixelBased.html @@ -1,138 +1,241 @@ - - - - Imagine\Filter\Advanced\OnPixelBased | - - - -
- + + + + Imagine\Filter\Advanced\OnPixelBased | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Advanced\OnPixelBased

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
  8. OnPixelBased
    9. +
+
+
+ +
+

+ OnPixelBased + +

+
+ +

class OnPixelBased implements - FilterInterface

+ FilterInterface +

+ + +
-

The OnPixelBased takes a callable, and for each pixel, this callable is called with the image (\Imagine\Image\ImageInterface) and the current point (\Imagine\Image\Point)

-

-

-
+

The OnPixelBased takes a callable, and for each pixel, this callable is called with the +image (\Imagine\Image\ImageInterface) and the current point (\Imagine\Image\Point).

-

Methods

+

Properties

- +
- - + + - -
- - - __construct($callback) -

-

+ 		+ protected callable $callback
+
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(callable $callback) + +

Initialize the instance.

+
+
+
+
ImageInterface - - +
+
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

- - - - + +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 27
- public - __construct($callback) +
+
+

+
at line 37
+ + __construct(callable $callback) +

-

-

-

-

-
+ + + +
+

Initialize the instance.

+

Parameters

- +
- + - +
callable $callback -
+

Exceptions

+ + + + + + +
InvalidArgumentException
+
-

-
at line 44
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 51
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Advanced/RelativeResize.html b/docs/API/API/Imagine/Filter/Advanced/RelativeResize.html index 9a5b6d16e..237aa78ab 100644 --- a/docs/API/API/Imagine/Filter/Advanced/RelativeResize.html +++ b/docs/API/API/Imagine/Filter/Advanced/RelativeResize.html @@ -1,81 +1,143 @@ - - - - Imagine\Filter\Advanced\RelativeResize | - - - -
- + + + + Imagine\Filter\Advanced\RelativeResize | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
-
+
+
+ -
Class
-

Imagine\Filter\Advanced\RelativeResize

+
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Advanced
  7. \
  8. RelativeResize
    9. +
+
+
+ +
+

+ RelativeResize + +

-
-

class + +

class RelativeResize implements - FilterInterface

+ FilterInterface +

+ + +
-

The RelativeResize filter allows images to be resized relative to their existing dimensions.

-

-

-
+

The RelativeResize filter allows images to be resized relative to their existing dimensions.

+

Methods

- - - - - - - - - - - -
+
+
+
-
+ +
__construct(string $method, mixed $parameter) -

Constructs a RelativeResize filter with the given method and argument.

-
+ +

Constructs a RelativeResize filter with the given method and argument.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 33
- public - __construct(string $method, mixed $parameter) +
+
+

+
at line 39
+ + __construct(string $method, mixed $parameter) +

-

Constructs a RelativeResize filter with the given method and argument.

-

-

-
+ + + +
+

Constructs a RelativeResize filter with the given method and argument.

+

Parameters

- +
@@ -94,47 +156,68 @@

Parameters

-

-
at line 46
- public ImageInterface - apply(ImageInterface $image) + +
+

+
at line 54
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

-

string $method
+
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-

+ diff --git a/docs/API/API/Imagine/Filter/Advanced/namespace-frame.html b/docs/API/API/Imagine/Filter/Advanced/namespace-frame.html deleted file mode 100644 index 645386827..000000000 --- a/docs/API/API/Imagine/Filter/Advanced/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Filter\Advanced | - - - diff --git a/docs/API/API/Imagine/Filter/Basic.html b/docs/API/API/Imagine/Filter/Basic.html index a848bb5ce..b5be5bcab 100644 --- a/docs/API/API/Imagine/Filter/Basic.html +++ b/docs/API/API/Imagine/Filter/Basic.html @@ -1,95 +1,230 @@ - - - - Imagine\Filter\Basic | - - - -
- + + + + Imagine\Filter\Basic | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ -
Namespace
-

Imagine\Filter\Basic

+
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
    8. +
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ApplyMaskAn apply mask filter
AutorotateRotates an image automatically based on exif information.
CopyA copy filter
CropA crop filter
FillA fill filter
FlipHorizontallyA "flip horizontally" filter
FlipVerticallyA "flip vertically" filter
PasteA paste filter
ResizeA resize filter
RotateA rotate filter
SaveA save filter
ShowA show filter
StripA strip filter
ThumbnailA thumbnail filter
WebOptimizationA filter to render web-optimized images
+
+ +
+

Imagine\Filter\Basic

+
+ + +

Classes

+ +
+
+
+ ApplyMask + +
+
+ An apply mask filter. +
+
+
+
+ Autorotate + +
+
+ Rotates an image automatically based on exif information. +
+
+
+
+ Copy + +
+
+ A copy filter. +
+
+
+
+ Crop + +
+
+ A crop filter. +
+
+
+
+ Fill + +
+
+ A fill filter. +
+
+
+
+ FlipHorizontally + +
+
+ A "flip horizontally" filter. +
+
+
+
+ FlipVertically + +
+
+ A "flip vertically" filter. +
+
+
+
+ Paste + +
+
+ A paste filter. +
+
+
+
+ Resize + +
+
+ A resize filter. +
+
+
+
+ Rotate + +
+
+ A rotate filter. +
+
+
+
+ Save + +
+
+ A save filter. +
+
+
+
+ Show + +
+
+ A show filter. +
+
+
+
+ Strip + +
+
+ A strip filter. +
+
+
+
+ Thumbnail + +
+
+ A thumbnail filter. +
+
+
+
+ WebOptimization + +
+
+ A filter to render web-optimized images. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/ApplyMask.html b/docs/API/API/Imagine/Filter/Basic/ApplyMask.html index c435a84b2..cd171caca 100644 --- a/docs/API/API/Imagine/Filter/Basic/ApplyMask.html +++ b/docs/API/API/Imagine/Filter/Basic/ApplyMask.html @@ -1,88 +1,147 @@ - - - - Imagine\Filter\Basic\ApplyMask | - - - -
- + + + + Imagine\Filter\Basic\ApplyMask | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\ApplyMask

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. ApplyMask
    9. +
+
+
+ +
+

+ ApplyMask + +

+
+ +

class ApplyMask implements - FilterInterface

+ FilterInterface +

+ + +
-

An apply mask filter

-

-

-
+

An apply mask filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
+ +
__construct(ImageInterface $mask) -

-

-
+ +

Initialize the instance.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 30
- public - __construct(ImageInterface $mask) +
+
+

+
at line 32
+ + __construct(ImageInterface $mask) +

-

-

-

-

-
+ + + +
+

Initialize the instance.

+

Parameters

- +
- +
ImageInterface $mask -
@@ -92,47 +151,68 @@

Parameters

-

-
at line 38
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 42
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/Autorotate.html b/docs/API/API/Imagine/Filter/Basic/Autorotate.html index fd0ca4bb7..13adcbd18 100644 --- a/docs/API/API/Imagine/Filter/Basic/Autorotate.html +++ b/docs/API/API/Imagine/Filter/Basic/Autorotate.html @@ -1,83 +1,172 @@ - - - - Imagine\Filter\Basic\Autorotate | - - - -
- + + + + Imagine\Filter\Basic\Autorotate | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\Autorotate

+ +
+
+
+ +
+ + +
-
-

class - Autorotate implements - FilterInterface

-
-

Rotates an image automatically based on exif information.

-

Your attention please: This filter requires the use of the -ExifMetadataReader to work.

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Autorotate
    9. +
+
+
+ +
+

+ Autorotate + +

+
+ +

class + Autorotate implements + FilterInterface +

+ + + +
+

Rotates an image automatically based on exif information.

Your attention please: This filter requires the use of the +ExifMetadataReader to work.

-

Methods

+

Constants

- +
- + - - + -
- - FLIP_VERTICALLY - __construct(string|array|ColorInterface $color = '000000') -

-

+

Image transformation: flip vertically.

+

- ImageInterface - FLIP_HORIZONTALLY - apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

+

Image transformation: flip horizontally.

+

+ + +

Methods

+ +
+
+
+ +
+
+ __construct(string|array|ColorInterface $color = '000000') + +

No description

+
+
+
+
+
+ ImageInterface +
+
+ apply(ImageInterface $image) + +

Applies scheduled transformation to an ImageInterface instance.

+
+
+
+
+ array +
+
+ getTransformations(ImageInterface $image) + +

Get the transformations.

+
+
+
+

Details

-

-
at line 33
- public - __construct(string|array|ColorInterface $color = '000000') +
+
+

+
at line 50
+ + __construct(string|array|ColorInterface $color = '000000') +

-

-

-

-

-
+ + + +

Parameters

- +
@@ -91,47 +180,108 @@

Parameters

-

-
at line 41
- public ImageInterface - apply(ImageInterface $image) + +
+

+
at line 60
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

-

string|array|ColorInterface $color
+
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+

+
at line 82
+ array + getTransformations(ImageInterface $image) + +

+
+ + +
+

Get the transformations.

+
+

Parameters

+ + + + + + + +
ImageInterface$image
+ + +

Return Value

+ + + + + + +
arrayan array containing Autorotate::FLIP_VERTICALLY, Autorotate::FLIP_HORIZONTALLY, rotation degrees
+ + + +
+
+
- + + +
+ + +

+ diff --git a/docs/API/API/Imagine/Filter/Basic/Copy.html b/docs/API/API/Imagine/Filter/Basic/Copy.html index 5de6762ff..0dd2b4a09 100644 --- a/docs/API/API/Imagine/Filter/Basic/Copy.html +++ b/docs/API/API/Imagine/Filter/Basic/Copy.html @@ -1,99 +1,177 @@ - - - - Imagine\Filter\Basic\Copy | - - - -
- + + + + Imagine\Filter\Basic\Copy | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
-
+
-
Class
-

Imagine\Filter\Basic\Copy

+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Copy
    9. +
+
+
+ +
+

+ Copy + +

-
-

class + +

class Copy implements - FilterInterface

+ FilterInterface +

+ + +
-

A copy filter

-

-

-
+

A copy filter.

+

Methods

- - - - - - -
+
+
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 25
- public ImageInterface - apply(ImageInterface $image) +
+
+

+
at line 27
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-

+ diff --git a/docs/API/API/Imagine/Filter/Basic/Crop.html b/docs/API/API/Imagine/Filter/Basic/Crop.html index 314995818..0585838b4 100644 --- a/docs/API/API/Imagine/Filter/Basic/Crop.html +++ b/docs/API/API/Imagine/Filter/Basic/Crop.html @@ -1,92 +1,152 @@ - - - - Imagine\Filter\Basic\Crop | - - - -
- + + + + Imagine\Filter\Basic\Crop | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\Crop

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Crop
    9. +
+
+
+ +
+

+ Crop + +

+
+ +

class Crop implements - FilterInterface

+ FilterInterface +

+ + +
-

A crop filter

-

-

-
+

A crop filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
+ +
__construct(PointInterface $start, BoxInterface $size) -

Constructs a Crop filter with given x, y, coordinates and crop width and height values

-
+ +

Constructs a Crop filter with given x, y, coordinates and crop width and height values.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 41
- public - __construct(PointInterface $start, BoxInterface $size) +
+
+

+
at line 40
+ + __construct(PointInterface $start, BoxInterface $size) +

-

Constructs a Crop filter with given x, y, coordinates and crop width and height values

-

-

-
+ + + +
+

Constructs a Crop filter with given x, y, coordinates and crop width and height values.

+

Parameters

- +
- + - +
PointInterface $start -
BoxInterface $size -
@@ -96,47 +156,68 @@

Parameters

-

-
at line 50
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 51
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/Fill.html b/docs/API/API/Imagine/Filter/Basic/Fill.html index 94dae7efd..46a1042d1 100644 --- a/docs/API/API/Imagine/Filter/Basic/Fill.html +++ b/docs/API/API/Imagine/Filter/Basic/Fill.html @@ -1,88 +1,146 @@ - - - - Imagine\Filter\Basic\Fill | - - - -
- + + + + Imagine\Filter\Basic\Fill | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\Fill

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Fill
    9. +
+
+
+ +
+

+ Fill + +

+
+ +

class Fill implements - FilterInterface

+ FilterInterface +

+ + +
-

A fill filter

-

-

-
+

A fill filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
+ +
__construct(FillInterface $fill) -

-

-
+ +

No description

+ +
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 31
- public - __construct(FillInterface $fill) +
+
+

+
at line 31
+ + __construct(FillInterface $fill) +

-

-

-

-

-
+ + + +

Parameters

- +
- +
FillInterface $fill -
@@ -92,47 +150,68 @@

Parameters

-

-
at line 39
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 41
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/FlipHorizontally.html b/docs/API/API/Imagine/Filter/Basic/FlipHorizontally.html index c0c192c06..8075147ef 100644 --- a/docs/API/API/Imagine/Filter/Basic/FlipHorizontally.html +++ b/docs/API/API/Imagine/Filter/Basic/FlipHorizontally.html @@ -1,99 +1,177 @@ - - - - Imagine\Filter\Basic\FlipHorizontally | - - - -
- + + + + Imagine\Filter\Basic\FlipHorizontally | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
-
+
-
Class
-

Imagine\Filter\Basic\FlipHorizontally

+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. FlipHorizontally
    9. +
+
+
+ +
+

+ FlipHorizontally + +

-
-

class + +

class FlipHorizontally implements - FilterInterface

+ FilterInterface +

+ + +
-

A "flip horizontally" filter

-

-

-
+

A "flip horizontally" filter.

+

Methods

- - - - - - -
+
+
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 25
- public ImageInterface - apply(ImageInterface $image) +
+
+

+
at line 27
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-

+ diff --git a/docs/API/API/Imagine/Filter/Basic/FlipVertically.html b/docs/API/API/Imagine/Filter/Basic/FlipVertically.html index d6bc9d80f..28510e259 100644 --- a/docs/API/API/Imagine/Filter/Basic/FlipVertically.html +++ b/docs/API/API/Imagine/Filter/Basic/FlipVertically.html @@ -1,99 +1,177 @@ - - - - Imagine\Filter\Basic\FlipVertically | - - - -
- + + + + Imagine\Filter\Basic\FlipVertically | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
-
+
-
Class
-

Imagine\Filter\Basic\FlipVertically

+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. FlipVertically
    9. +
+
+
+ +
+

+ FlipVertically + +

-
-

class + +

class FlipVertically implements - FilterInterface

+ FilterInterface +

+ + +
-

A "flip vertically" filter

-

-

-
+

A "flip vertically" filter.

+

Methods

- - - - - - -
+
+
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 25
- public ImageInterface - apply(ImageInterface $image) +
+
+

+
at line 27
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-

+ diff --git a/docs/API/API/Imagine/Filter/Basic/Paste.html b/docs/API/API/Imagine/Filter/Basic/Paste.html index 880d8faac..7c186ed8b 100644 --- a/docs/API/API/Imagine/Filter/Basic/Paste.html +++ b/docs/API/API/Imagine/Filter/Basic/Paste.html @@ -1,92 +1,159 @@ - - - - Imagine\Filter\Basic\Paste | - - - -
- + + + + Imagine\Filter\Basic\Paste | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\Paste

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Paste
    9. +
+
+
+ +
+

+ Paste + +

+
+ +

class Paste implements - FilterInterface

+ FilterInterface +

+ + +
-

A paste filter

-

-

-
+

A paste filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
- __construct(ImageInterface $image, PointInterface $start) -

Constructs a Paste filter with given ImageInterface to paste and x, y coordinates of target position

-
+ +
+ __construct(ImageInterface $image, PointInterface $start, int $alpha = 100) + +

Constructs a Paste filter with given ImageInterface to paste and x, y +coordinates of target position.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 40
- public - __construct(ImageInterface $image, PointInterface $start) +
+
+

+
at line 49
+ + __construct(ImageInterface $image, PointInterface $start, int $alpha = 100) +

-

Constructs a Paste filter with given ImageInterface to paste and x, y coordinates of target position

-

-

-
+ + + +
+

Constructs a Paste filter with given ImageInterface to paste and x, y +coordinates of target position.

+

Parameters

- +
- + - + + + + + +
ImageInterface $image -
PointInterface $start -
int$alphahow to paste the image, from 0 (fully transparent) to 100 (fully opaque)
@@ -96,47 +163,68 @@

Parameters

-

-
at line 49
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 65
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/Resize.html b/docs/API/API/Imagine/Filter/Basic/Resize.html index 1ddce6b57..804051679 100644 --- a/docs/API/API/Imagine/Filter/Basic/Resize.html +++ b/docs/API/API/Imagine/Filter/Basic/Resize.html @@ -1,92 +1,152 @@ - - - - Imagine\Filter\Basic\Resize | - - - -
- + + + + Imagine\Filter\Basic\Resize | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\Resize

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Resize
    9. +
+
+
+ +
+

+ Resize + +

+
+ +

class Resize implements - FilterInterface

+ FilterInterface +

+ + +
-

A resize filter

-

-

-
+

A resize filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
+ +
__construct(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) -

Constructs Resize filter with given width and height

-
+ +

Constructs Resize filter with given width and height.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 35
- public - __construct(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +
+
+

+
at line 39
+ + __construct(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Constructs Resize filter with given width and height

-

-

-
+ + + +
+

Constructs Resize filter with given width and height.

+

Parameters

- +
- + - +
BoxInterface $size -
string $filter -
@@ -96,47 +156,68 @@

Parameters

-

-
at line 44
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 50
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/Rotate.html b/docs/API/API/Imagine/Filter/Basic/Rotate.html index 8cc29efca..aaebfd0c9 100644 --- a/docs/API/API/Imagine/Filter/Basic/Rotate.html +++ b/docs/API/API/Imagine/Filter/Basic/Rotate.html @@ -1,92 +1,152 @@ - - - - Imagine\Filter\Basic\Rotate | - - - -
- + + + + Imagine\Filter\Basic\Rotate | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\Rotate

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Rotate
    9. +
+
+
+ +
+

+ Rotate + +

+
+ +

class Rotate implements - FilterInterface

+ FilterInterface +

+ + +
-

A rotate filter

-

-

-
+

A rotate filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
- __construct(integer $angle, ColorInterface $background = null) -

Constructs Rotate filter with given angle and background color

-
+ +
+ __construct(int $angle, ColorInterface $background = null) + +

Constructs Rotate filter with given angle and background color.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 39
- public - __construct(integer $angle, ColorInterface $background = null) +
+
+

+
at line 39
+ + __construct(int $angle, ColorInterface $background = null) +

-

Constructs Rotate filter with given angle and background color

-

-

-
+ + + +
+

Constructs Rotate filter with given angle and background color.

+

Parameters

- +
- + - + - +
integerint $angle -
ColorInterface $background -
@@ -96,47 +156,68 @@

Parameters

-

-
at line 48
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 50
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/Save.html b/docs/API/API/Imagine/Filter/Basic/Save.html index 819bb280e..2a9698879 100644 --- a/docs/API/API/Imagine/Filter/Basic/Save.html +++ b/docs/API/API/Imagine/Filter/Basic/Save.html @@ -1,92 +1,152 @@ - - - - Imagine\Filter\Basic\Save | - - - -
- + + + + Imagine\Filter\Basic\Save | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\Save

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Save
    9. +
+
+
+ +
+

+ Save + +

+
+ +

class Save implements - FilterInterface

+ FilterInterface +

+ + +
-

A save filter

-

-

-
+

A save filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
+ +
__construct(string $path = null, array $options = array()) -

Constructs Save filter with given path and options

-
+ +

Constructs Save filter with given path and options.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 38
- public - __construct(string $path = null, array $options = array()) +
+
+

+
at line 38
+ + __construct(string $path = null, array $options = array()) +

-

Constructs Save filter with given path and options

-

-

-
+ + + +
+

Constructs Save filter with given path and options.

+

Parameters

- +
- + - +
string $path -
array $options -
@@ -96,47 +156,68 @@

Parameters

-

-
at line 47
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 49
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/Show.html b/docs/API/API/Imagine/Filter/Basic/Show.html index db95ace29..a20479dad 100644 --- a/docs/API/API/Imagine/Filter/Basic/Show.html +++ b/docs/API/API/Imagine/Filter/Basic/Show.html @@ -1,92 +1,152 @@ - - - - Imagine\Filter\Basic\Show | - - - -
- + + + + Imagine\Filter\Basic\Show | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\Show

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Show
    9. +
+
+
+ +
+

+ Show + +

+
+ +

class Show implements - FilterInterface

+ FilterInterface +

+ + +
-

A show filter

-

-

-
+

A show filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
+ +
__construct(string $format, array $options = array()) -

Constructs the Show filter with given format and options

-
+ +

Constructs the Show filter with given format and options.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 38
- public - __construct(string $format, array $options = array()) +
+
+

+
at line 38
+ + __construct(string $format, array $options = array()) +

-

Constructs the Show filter with given format and options

-

-

-
+ + + +
+

Constructs the Show filter with given format and options.

+

Parameters

- +
- + - +
string $format -
array $options -
@@ -96,47 +156,68 @@

Parameters

-

-
at line 47
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 49
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/Strip.html b/docs/API/API/Imagine/Filter/Basic/Strip.html index f91c92fbb..770414198 100644 --- a/docs/API/API/Imagine/Filter/Basic/Strip.html +++ b/docs/API/API/Imagine/Filter/Basic/Strip.html @@ -1,99 +1,177 @@ - - - - Imagine\Filter\Basic\Strip | - - - -
- + + + + Imagine\Filter\Basic\Strip | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
-
+
-
Class
-

Imagine\Filter\Basic\Strip

+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Strip
    9. +
+
+
+ +
+

+ Strip + +

-
-

class + +

class Strip implements - FilterInterface

+ FilterInterface +

+ + +
-

A strip filter

-

-

-
+

A strip filter.

+

Methods

- - - - - - -
+
+
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 25
- public ImageInterface - apply(ImageInterface $image) +
+
+

+
at line 27
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-

+ diff --git a/docs/API/API/Imagine/Filter/Basic/Thumbnail.html b/docs/API/API/Imagine/Filter/Basic/Thumbnail.html index f6a02d7dc..910882ae7 100644 --- a/docs/API/API/Imagine/Filter/Basic/Thumbnail.html +++ b/docs/API/API/Imagine/Filter/Basic/Thumbnail.html @@ -1,98 +1,157 @@ - - - - Imagine\Filter\Basic\Thumbnail | - - - -
- + + + + Imagine\Filter\Basic\Thumbnail | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Filter\Basic\Thumbnail

+ +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. Thumbnail
    9. +
+
+
+ +
+

+ Thumbnail + +

+
+ +

class Thumbnail implements - FilterInterface

+ FilterInterface +

+ + +
-

A thumbnail filter

-

-

-
+

A thumbnail filter.

+

Methods

- - - - - - - - - - - -
+
+
+
-
- __construct(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) -

Constructs the Thumbnail filter with given width, height and mode

-
+ +
+ __construct(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

Constructs the Thumbnail filter.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 45
- public - __construct(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +
+
+

+
at line 45
+ + __construct(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Constructs the Thumbnail filter with given width, height and mode

-

-

-
+ + + +
+

Constructs the Thumbnail filter.

+

Parameters

- +
- + - - - + + + - +
BoxInterface $size -
string$mode -int|string$settingsOne or more of the ManipulatorInterface::THUMBNAIL_ flags (joined with |). It may be a string for backward compatibility with old constant values that were strings.
string $filter -See ImageInterface::FILTER_... constants
@@ -102,47 +161,68 @@

Parameters

-

-
at line 55
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 57
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/WebOptimization.html b/docs/API/API/Imagine/Filter/Basic/WebOptimization.html index 50dba179f..7fb8146d8 100644 --- a/docs/API/API/Imagine/Filter/Basic/WebOptimization.html +++ b/docs/API/API/Imagine/Filter/Basic/WebOptimization.html @@ -1,94 +1,151 @@ - - - - Imagine\Filter\Basic\WebOptimization | - - - -
- + + + + Imagine\Filter\Basic\WebOptimization | Imagine API v1.2.5-dev + + + + + + + + + + + + + + -
+ +
+
+
+ +
+ + +
+
+ +
+ +
+
+ -
Class
-

Imagine\Filter\Basic\WebOptimization

+
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Basic
  7. \
  8. WebOptimization
    9. +
+
+
+ +
+

+ WebOptimization + +

-
-

class + +

class WebOptimization implements - FilterInterface

+ FilterInterface +

+ + +
-

A filter to render web-optimized images

-

-

-
+

A filter to render web-optimized images.

+

Methods

- - - - - - - - - - - -
+
+
+
-
- __construct($path = null, array $options = array()) -

-

-
+ +
+ __construct(string|callable|null $path = null, array $options = array()) + +

No description

+
+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 27
- public - __construct($path = null, array $options = array()) +
+
+

+
at line 42
+ + __construct(string|callable|null $path = null, array $options = array()) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - + - +
string|callable|null $path -
array $options -
@@ -98,47 +155,68 @@

Parameters

-

-
at line 41
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 58
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/Basic/namespace-frame.html b/docs/API/API/Imagine/Filter/Basic/namespace-frame.html deleted file mode 100644 index 399e8d9cc..000000000 --- a/docs/API/API/Imagine/Filter/Basic/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Filter\Basic | - - - diff --git a/docs/API/API/Imagine/Filter/FilterInterface.html b/docs/API/API/Imagine/Filter/FilterInterface.html index d1a7886ef..56e066da2 100644 --- a/docs/API/API/Imagine/Filter/FilterInterface.html +++ b/docs/API/API/Imagine/Filter/FilterInterface.html @@ -1,86 +1,146 @@ - - - - Imagine\Filter\FilterInterface | - - - -
- + + + + Imagine\Filter\FilterInterface | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Interface
-

Imagine\Filter\FilterInterface

+ +
+
+
+ +
+ + +
-
-

interface - FilterInterface

-
-

Interface for imagine filters

-

-

+
+
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. FilterInterface
    7. +
+
+
+ +
+

+ FilterInterface + +

+
+ +

interface + FilterInterface +

+ + + + +
+

Interface for imagine filters.

+

Methods

- - - - - - -
+
+
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+
+

Details

-

-
at line 29
- public ImageInterface - apply(ImageInterface $image) +
+
+

+
at line 28
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
@@ -89,10 +149,17 @@

Return Value

+
+
+
-

+ diff --git a/docs/API/API/Imagine/Filter/ImagineAware.html b/docs/API/API/Imagine/Filter/ImagineAware.html index 3f100453c..572a01376 100644 --- a/docs/API/API/Imagine/Filter/ImagineAware.html +++ b/docs/API/API/Imagine/Filter/ImagineAware.html @@ -1,81 +1,143 @@ - - - - Imagine\Filter\ImagineAware | - - - -
- + + + + Imagine\Filter\ImagineAware | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
-
+
-
Class
-

Imagine\Filter\ImagineAware

+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. ImagineAware
    7. +
+
+
+ +
+

+ ImagineAware + +

-
-

abstract class + +

abstract class ImagineAware implements - FilterInterface

+ FilterInterface +

+ + +
-

ImagineAware base class

-

-

-
+

ImagineAware base class.

+

Methods

- - - - - - - - - - - -
+
+
+
-
+ +
setImagine(ImagineInterface $imagine) -

Set ImagineInterface instance.

-
+ +

Set ImagineInterface instance.

+
+ +
+
ImagineInterface -
+ +
getImagine() -

Get ImagineInterface instance.

-
+ +

Get ImagineInterface instance.

+
+
+

Details

-

-
at line 34
- public - setImagine(ImagineInterface $imagine) +
+
+

+
at line 34
+ + setImagine(ImagineInterface $imagine) +

-

Set ImagineInterface instance.

-

-

-
+ + + +
+

Set ImagineInterface instance.

+

Parameters

- +
@@ -89,35 +151,38 @@

Parameters

-

-
at line 46
- public ImagineInterface - getImagine() + +
+

+
at line 46
+ ImagineInterface + getImagine() +

-

Get ImagineInterface instance.

-

-

-
+ + + +
+

Get ImagineInterface instance.

+

Return Value

-

ImagineInterface $imagine
+
- +
ImagineInterface -

Exceptions

- +
- - + +
InvalidArgumentException -InvalidArgumentException
@@ -125,10 +190,17 @@

Exceptions

+
+
+
-

+ diff --git a/docs/API/API/Imagine/Filter/Transformation.html b/docs/API/API/Imagine/Filter/Transformation.html index 3c196b36e..3a7a50408 100644 --- a/docs/API/API/Imagine/Filter/Transformation.html +++ b/docs/API/API/Imagine/Filter/Transformation.html @@ -1,241 +1,311 @@ - - - - Imagine\Filter\Transformation | - - - -
- - -
- -
Class
-

Imagine\Filter\Transformation

+ + + + Imagine\Filter\Transformation | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Filter
  5. \
  6. Transformation
    7. +
+
+
+ +
+

+ Transformation + +

-
-

class + +

class Transformation implements - FilterInterface, ManipulatorInterface

+ FilterInterface, ManipulatorInterface +

+ + +
-

A transformation filter

-

-

-
+

A transformation filter.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
+ +
__construct(ImagineInterface $imagine = null) -

Class constructor.

-
+ +

Class constructor.

+
+ +
+
ImageInterface -
+ +
applyFilter(ImageInterface $image, FilterInterface $filter) -

Applies a given FilterInterface onto given ImageInterface and returns modified ImageInterface

-
+ +

Applies a given FilterInterface onto given ImageInterface and returns modified ImageInterface.

+
+ +
+
array -
+ +
getFilters() -

Returns a list of filters sorted by their priority.

-
+ +

Returns a list of filters sorted by their priority. Filters with same priority will be returned in the order they were added.

+
+ +
+
ImageInterface -
+ +
apply(ImageInterface $image) -

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-
+ +

Applies scheduled transformation to an ImageInterface instance.

+
+ +
+
ManipulatorInterface -
+ +
copy() -

Copies current source image into a new ImageInterface instance

-
- ManipulatorInterface - + +

Copies current source image into a new ImageInterface instance.

+
+ +
+
+ $this +
+
crop(PointInterface $start, BoxInterface $size) -

Crops a specified box out of the source image (modifies the source image) Returns cropped self

-
- ManipulatorInterface - + +

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+
+ +
+
+ $this +
+
flipHorizontally() -

Flips current image using horizontal axis

-
- ManipulatorInterface - + +

Flips current image using vertical axis.

+
+ +
+
+ $this +
+
flipVertically() -

Flips current image using vertical axis

-
- ManipulatorInterface - + +

Flips current image using horizontal axis.

+
+ +
+
+ $this +
+
strip() -

Remove all profiles and comments

-
- ManipulatorInterface - - paste(ImageInterface $image, PointInterface $start) -

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

-
- ManipulatorInterface - + +

Remove all profiles and comments.

+
+ +
+
+ $this +
+
+ paste(ImageInterface $image, PointInterface $start, int $alpha = 100) + +

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

+
+
+
+
+ $this +
+
applyMask(ImageInterface $mask) -

Applies a given mask to current image's alpha channel

-
- ManipulatorInterface - + +

Applies a given mask to current image's alpha channel.

+
+ +
+
+ $this +
+
fill(FillInterface $fill) -

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

-
- ManipulatorInterface - + +

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+
+ +
+
+ $this +
+
resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) -

Resizes current image and returns self

-
- ManipulatorInterface - - rotate(integer $angle, ColorInterface $background = null) -

Rotates an image at the given angle.

-
- ManipulatorInterface - + +

Resizes current image and returns self.

+
+ +
+
+ $this +
+
+ rotate(int $angle, ColorInterface $background = null) + +

Rotates an image at the given angle.

+
+
+
+
+ $this +
+
save(string $path = null, array $options = array()) -

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

-
- ManipulatorInterface - + +

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

+
+ +
+
+ $this +
+
show(string $format, array $options = array()) -

Outputs the image content

-
+ +

Outputs the image content.

+
+ +
+
ManipulatorInterface -
- thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) -

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

-
- Transformation - - add(FilterInterface $filter, int $priority) -

Registers a given FilterInterface in an internal array of filters for later application to an instance of ImageInterface

-
+
+
+ thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
+
+
+
+ $this +
+
+ add(FilterInterface $filter, int $priority = 0) + +

Registers a given FilterInterface in an internal array of filters for later application to an instance of ImageInterface.

+
+
+

Details

-

-
at line 63
- public - __construct(ImagineInterface $imagine = null) +
+
+

+
at line 63
+ + __construct(ImagineInterface $imagine = null) +

-

Class constructor.

-

-

-
+ + + +
+

Class constructor.

+

Parameters

- +
@@ -249,52 +319,53 @@

Parameters

-

-
at line 78
- public ImageInterface - applyFilter(ImageInterface $image, FilterInterface $filter) + +
+

+
at line 78
+ ImageInterface + applyFilter(ImageInterface $image, FilterInterface $filter) +

-

Applies a given FilterInterface onto given ImageInterface and returns modified ImageInterface

-

-

-
+ + + +
+

Applies a given FilterInterface onto given ImageInterface and returns modified ImageInterface.

+

Parameters

-

ImagineInterface $imagine
+
- + - +
ImageInterface $image -
FilterInterface $filter -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
InvalidArgumentException -InvalidArgumentException
@@ -302,23 +373,28 @@

Exceptions

-

-
at line 95
- public array - getFilters() +

+
+

+
at line 95
+ array + getFilters() +

-

Returns a list of filters sorted by their priority.

-

Filters with same priority will be returned in the order they were added.

-
+ + + +
+

Returns a list of filters sorted by their priority. Filters with same priority will be returned in the order they were added.

+

Return Value

- +
- +
array -
@@ -327,617 +403,798 @@

Return Value

-

-
at line 108
- public ImageInterface - apply(ImageInterface $image) +

+
+

+
at line 114
+ ImageInterface + apply(ImageInterface $image) +

-

Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance

-

-

-
+ + + +
+

Applies scheduled transformation to an ImageInterface instance.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- +
ImageInterface -returns the processed ImageInterface instance
+

See also

+ + + + + + +
+ FilterInterface::apply +
+
-

-
at line 120
- public ManipulatorInterface - copy() +

+
+

+
at line 128
+ ManipulatorInterface + copy() +

-

Copies current source image into a new ImageInterface instance

-

-

-
+ + + +
+

Copies current source image into a new ImageInterface instance.

+

Return Value

- +
- +
ManipulatorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::copy +
+
-

-
at line 128
- public ManipulatorInterface - crop(PointInterface $start, BoxInterface $size) +

+
+

+
at line 138
+ $this + crop(PointInterface $start, BoxInterface $size) +

-

Crops a specified box out of the source image (modifies the source image) Returns cropped self

-

-

-
+ + + +
+

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+

Parameters

- +
- + - +
PointInterface $start -
BoxInterface $size -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + +
OutOfBoundsException -OutOfBoundsException
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::crop +
+
-

-
at line 136
- public ManipulatorInterface - flipHorizontally() +

+
+

+
at line 148
+ $this + flipHorizontally() +

-

Flips current image using horizontal axis

-

-

-
+ + + +
+

Flips current image using vertical axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::flipHorizontally +
+
-

-
at line 144
- public ManipulatorInterface - flipVertically() +

+
+

+
at line 158
+ $this + flipVertically() +

-

Flips current image using vertical axis

-

-

-
+ + + +
+

Flips current image using horizontal axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::flipVertically +
+
-

-
at line 152
- public ManipulatorInterface - strip() +

+
+

+
at line 168
+ $this + strip() +

-

Remove all profiles and comments

-

-

-
+ + + +
+

Remove all profiles and comments.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::strip +
+
-

-
at line 160
- public ManipulatorInterface - paste(ImageInterface $image, PointInterface $start) +

+
+

+
at line 178
+ $this + paste(ImageInterface $image, PointInterface $start, int $alpha = 100) +

-

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

-

Returns source image

-
+ + + +
+

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

Returns source image

+

Parameters

- +
- + - + + + + + +
ImageInterface $image -
PointInterface $start -
int$alphaHow to paste the image, from 0 (fully transparent) to 100 (fully opaque)

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + + +
InvalidArgumentException -InvalidArgumentException
OutOfBoundsException -RuntimeException
+ + +

See also

+ + - + ManipulatorInterface::paste + +
RuntimeException -
-
-

-
at line 168
- public ManipulatorInterface - applyMask(ImageInterface $mask) +

+
+

+
at line 188
+ $this + applyMask(ImageInterface $mask) +

-

Applies a given mask to current image's alpha channel

-

-

-
+ + + +
+

Applies a given mask to current image's alpha channel.

+

Parameters

- +
- +
ImageInterface $mask -

Return Value

- +
- - + +
ManipulatorInterface -$this
+

See also

+ + + + + + +
+ ManipulatorInterface::applyMask +
+
-

-
at line 176
- public ManipulatorInterface - fill(FillInterface $fill) +

+
+

+
at line 198
+ $this + fill(FillInterface $fill) +

-

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

-

-

-
+ + + +
+

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+

Parameters

- +
- +
FillInterface $fill -

Return Value

- +
- - + +
ManipulatorInterface -$this
+

See also

+ + + + + + +
+ ManipulatorInterface::fill +
+
-

-
at line 184
- public ManipulatorInterface - resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
at line 208
+ $this + resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Resizes current image and returns self

-

-

-
+ + + +
+

Resizes current image and returns self.

+

Parameters

- +
- + - +
BoxInterface $size -
string $filter -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::resize +
+
-

-
at line 192
- public ManipulatorInterface - rotate(integer $angle, ColorInterface $background = null) +

+
+

+
at line 218
+ $this + rotate(int $angle, ColorInterface $background = null) +

-

Rotates an image at the given angle.

-

Optional $background can be used to specify the fill color of the empty -area of rotated image.

-
+ + + +
+

Rotates an image at the given angle.

Optional $background can be used to specify the fill color of the empty +area of rotated image.

+

Parameters

- +
- + - + - +
integerint $angle -
ColorInterface $background -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::rotate +
+
-

-
at line 200
- public ManipulatorInterface - save(string $path = null, array $options = array()) +

+
+

+
at line 228
+ $this + save(string $path = null, array $options = array()) +

-

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

-

-

-
+ + + +
+

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

Please remark that bmp is supported by the GD driver only since PHP 7.2.

+

Parameters

- +
- + - +
string $path -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::save +
+
-

-
at line 208
- public ManipulatorInterface - show(string $format, array $options = array()) +

+
+

+
at line 238
+ $this + show(string $format, array $options = array()) +

-

Outputs the image content

-

-

-
+ + + +
+

Outputs the image content.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::show +
+
-

-
at line 216
- public ManipulatorInterface - thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
at line 248
+ ManipulatorInterface + thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

-

-

-
+ + + +
+

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+

Parameters

- +
- + - - - + + + @@ -949,64 +1206,75 @@

Parameters

Return Value

-
BoxInterface $size -
string$mode -int|string$settingsOne or more of the ManipulatorInterface::THUMBNAIL_ flags (joined with |). It may be a string for backward compatibility with old constant values that were strings.
string
+
- +
ManipulatorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::thumbnail +
+
-

-
at line 229
- public Transformation - add(FilterInterface $filter, int $priority) +

+
+

+
at line 261
+ $this + add(FilterInterface $filter, int $priority = 0) +

-

Registers a given FilterInterface in an internal array of filters for later application to an instance of ImageInterface

-

-

-
+ + + +
+

Registers a given FilterInterface in an internal array of filters for later application to an instance of ImageInterface.

+

Parameters

- +
- + - +
FilterInterface $filter -
int $priority -

Return Value

- +
- - + +
Transformation -$this
@@ -1015,10 +1283,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Filter/namespace-frame.html b/docs/API/API/Imagine/Filter/namespace-frame.html deleted file mode 100644 index 53a29636b..000000000 --- a/docs/API/API/Imagine/Filter/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Filter | - - - diff --git a/docs/API/API/Imagine/Gd.html b/docs/API/API/Imagine/Gd.html index fa0ca7110..982b6a32f 100644 --- a/docs/API/API/Imagine/Gd.html +++ b/docs/API/API/Imagine/Gd.html @@ -1,60 +1,149 @@ - - - - Imagine\Gd | - - - -
- - -
- -
Namespace
-

Imagine\Gd

+ + + + Imagine\Gd | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Gd
  5. \
    6. +
+
+
+ +
+

Imagine\Gd

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
DrawerDrawer implementation using the GD library
EffectsEffects implementation using the GD library
FontFont implementation using the GD library
ImageImage implementation using the GD library
ImagineImagine implementation using the GD library
Layers -
+ + +

Classes

+ +
+
+
+ Drawer + +
+
+ Drawer implementation using the GD PHP extension. +
+
+
+
+ Effects + +
+
+ Effects implementation using the GD PHP extension. +
+
+
+
+ Font + +
+
+ Font implementation using the GD library. +
+
+
+
+ Image + +
+
+ Image implementation using the GD library. +
+
+
+
+ Imagine + +
+
+ Imagine implementation using the GD library. +
+
+
+
+ Layers + +
+
+ +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gd/Drawer.html b/docs/API/API/Imagine/Gd/Drawer.html index 5cec4d870..e9ff3dd18 100644 --- a/docs/API/API/Imagine/Gd/Drawer.html +++ b/docs/API/API/Imagine/Gd/Drawer.html @@ -1,715 +1,1043 @@ - - - - Imagine\Gd\Drawer | - - - -
- - -
- -
Class
-

Imagine\Gd\Drawer

+ + + + Imagine\Gd\Drawer | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gd
  5. \
  6. Drawer
    7. +
+
+
+ +
+

+ Drawer + +

+
+ +

class Drawer implements - DrawerInterface

+ DrawerInterface +

+ + +
-

Drawer implementation using the GD library

-

-

-
+

Drawer implementation using the GD PHP extension.

+

Methods

- - - - - - + +
+ __construct(resource|GdImage $resource) + +

Constructs Drawer with a given gd image resource.

+
+ +
+
+ $this +
+
+ arc(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, int $thickness = 1) + +

Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.

+
+
+
+
+ $this +
+
+ chord(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

This function does not work properly because of a bug in GD.

+
+
+
+
+ $this +
+
+ circle(PointInterface $center, int $radius, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws and circle with center at the given x, y coordinates, and given radius.

+
+
+
+
+ $this +
+
+ ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws and ellipse with center at the given x, y coordinates, and given width and height.

+
+
+
+
+ $this +
+
+ line(PointInterface $start, PointInterface $end, ColorInterface $color, int $thickness = 1) + +

Draws a line from start(x, y) to end(x, y) coordinates.

+
+
+
+
+ $this +
+
+ pieSlice(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Same as arc, but connects end points and the center.

+
+
+
+
+ $this +
+
+ dot(PointInterface $position, ColorInterface $color) + +

Places a one pixel point at specific coordinates and fills it with +specified color.

+
+
+
+
+ $this +
+
+ rectangle(PointInterface $leftTop, PointInterface $rightBottom, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.

+
+
+
+
+ $this +
+
+ polygon(array $coordinates, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.

+
+
+
+
+ $this +
+
+ text(string $string, AbstractFont $font, PointInterface $position, int $angle = 0, int $width = null) + +

Annotates image with specified text at a given position starting on the top left of the final text box.

+
+
+ + + +

Details

+ +
+
+

+
at line 44
+ + __construct(resource|GdImage $resource) + +

+
+ + + +
+

Constructs Drawer with a given gd image resource.

+
+

Parameters

+ +
+
+
+
-
- __construct(resource $resource) -

Constructs Drawer with a given gd image resource

-
- - + + +
- DrawerInterface - - arc(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, integer $thickness = 1) -

Draws an arc on a starting at a given x, y coordinates under a given start and end angles

- 		resource|GdImage$resource
+ + + + +
+
+ +
+
+

+
at line 55
+ $this + arc(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, int $thickness = 1) + +

+
+ + + +
+

Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.

+
+

Parameters

+ + - - + + - - + + - - + + - - + + - - + + - - + + +
- DrawerInterface - - chord(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

This function does not work properly because of a bug in GD

- 		PointInterface$center
- DrawerInterface - - ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Draws and ellipse with center at the given x, y coordinates, and given width and height

- 		BoxInterface$size
- DrawerInterface - - line(PointInterface $start, PointInterface $end, ColorInterface $color, integer $thickness = 1) -

Draws a line from start(x, y) to end(x, y) coordinates

- 		int$start
- DrawerInterface - - pieSlice(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Same as arc, but connects end points and the center

- 		int$end
- DrawerInterface - - dot(PointInterface $position, ColorInterface $color) -

Places a one pixel point at specific coordinates and fills it with specified color

- 		ColorInterface$color
- DrawerInterface - - polygon(array $coordinates, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Draws a polygon using array of x, y coordinates.

- 		int$thickness
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + - - +
- DrawerInterface - - text(string $string, AbstractFont $font, PointInterface $position, integer $angle, integer $width = null) -

Annotates image with specified text at a given position starting on the top left of the final text box

- 		RuntimeException
+ +

See also

-

Details

- -

-
at line 43
- public - __construct(resource $resource) -

-
-

Constructs Drawer with a given gd image resource

-

-

-
-

Parameters

- - +
- - + DrawerInterface::arc + +
resource$resource -
- - -
-

-
at line 52
- public DrawerInterface - arc(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, integer $thickness = 1) +

+
+

+
at line 86
+ $this + chord(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws an arc on a starting at a given x, y coordinates under a given start and end angles

-

-

-
+ + + +
+

This function does not work properly because of a bug in GD.

{@inheritdoc}

+

Parameters

- +
- + - + - + - + - + - + - + + + + + + - + - +
PointInterface $center -
BoxInterface $size -
integerint $start -
integerint $end -
ColorInterface $color -
bool$fill
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this
-

Exceptions

+ +

See also

- +
- + DrawerInterface::chord + +
RuntimeException -
-
-

-
at line 77
- public DrawerInterface - chord(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 125
+ $this + circle(PointInterface $center, int $radius, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

This function does not work properly because of a bug in GD

-

{@inheritdoc}

-
+ + + +
+

Draws and circle with center at the given x, y coordinates, and given radius.

+

Parameters

- +
- - - - - - - - - - - + - - - + + + - + - + - + - + - +
PointInterface $center -
BoxInterface$size -
integer$start -
integer$end -int$radius
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this
+

Exceptions

+ + + + + + +
RuntimeException
+ +

See also

+ + + + + + +
+ DrawerInterface::circle +
+
-

-
at line 106
- public DrawerInterface - ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 137
+ $this + ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws and ellipse with center at the given x, y coordinates, and given width and height

-

-

-
+ + + +
+

Draws and ellipse with center at the given x, y coordinates, and given width and height.

+

Parameters

- +
- + - + - + - + - + - + - +
PointInterface $center -
BoxInterface $size -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::ellipse +
+
-

-
at line 135
- public DrawerInterface - line(PointInterface $start, PointInterface $end, ColorInterface $color, integer $thickness = 1) +

+
+

+
at line 181
+ $this + line(PointInterface $start, PointInterface $end, ColorInterface $color, int $thickness = 1) +

-

Draws a line from start(x, y) to end(x, y) coordinates

-

-

-
+ + + +
+

Draws a line from start(x, y) to end(x, y) coordinates.

+

Parameters

- +
- + - + - + - + - +
PointInterface $start -
PointInterface $end -
ColorInterface $color -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this
+

See also

+ + + + + + +
+ DrawerInterface::line +
+
-

-
at line 158
- public DrawerInterface - pieSlice(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 210
+ $this + pieSlice(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Same as arc, but connects end points and the center

-

-

-
+ + + +
+

Same as arc, but connects end points and the center.

+

Parameters

- +
- + - + - + - + - + - + - + - + - + - + - +
PointInterface $center -
BoxInterface $size -
integerint $start -
integerint $end -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::pieSlice +
+
-

-
at line 187
- public DrawerInterface - dot(PointInterface $position, ColorInterface $color) +

+
+

+
at line 245
+ $this + dot(PointInterface $position, ColorInterface $color) +

-

Places a one pixel point at specific coordinates and fills it with specified color

-

-

-
+ + + +
+

Places a one pixel point at specific coordinates and fills it with +specified color.

+

Parameters

- +
- + - +
PointInterface $position -
ColorInterface $color -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
+ + + + +
RuntimeException
+ + +

See also

+ + - + DrawerInterface::dot + +
RuntimeException -
+
+
+ +
+
+

+
at line 268
+ $this + rectangle(PointInterface $leftTop, PointInterface $rightBottom, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

+
+ + +
+

Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
PointInterface$leftTop
PointInterface$rightBottom
ColorInterface$color
bool$fill
int$thickness
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +

See also

+ + + + + + +
+ DrawerInterface::rectangle +
+
-

-
at line 208
- public DrawerInterface - polygon(array $coordinates, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 308
+ $this + polygon(array $coordinates, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws a polygon using array of x, y coordinates.

-

Must contain at least -three coordinates

-
+ + + +
+

Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.

+

Parameters

- +
- + - + - + - + - + - +
array $coordinates -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::polygon +
+
-

-
at line 245
- public DrawerInterface - text(string $string, AbstractFont $font, PointInterface $position, integer $angle, integer $width = null) +

+
+

+
at line 351
+ $this + text(string $string, AbstractFont $font, PointInterface $position, int $angle = 0, int $width = null) +

-

Annotates image with specified text at a given position starting on the top left of the final text box

-

The rotation is done CW

-
+ + + +
+

Annotates image with specified text at a given position starting on the top left of the final text box.

The rotation is done CW

+

Parameters

- +
- + - + - + - + - + - + - +
string $string -
AbstractFont $font -
PointInterface $position -
integerint $angle -
integerint $width -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::text +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gd/Effects.html b/docs/API/API/Imagine/Gd/Effects.html index b324de60d..bdb78704e 100644 --- a/docs/API/API/Imagine/Gd/Effects.html +++ b/docs/API/API/Imagine/Gd/Effects.html @@ -1,138 +1,217 @@ - - - - Imagine\Gd\Effects | - - - -
- - -
- -
Class
-

Imagine\Gd\Effects

+ + + + Imagine\Gd\Effects | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gd
  5. \
  6. Effects
    7. +
+
+
+ +
+

+ Effects + +

+
+ +

class Effects implements - EffectsInterface

+ EffectsInterface +

+ + +
-

Effects implementation using the GD library

-

-

-
+

Effects implementation using the GD PHP extension.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct($resource) -

-

-
- EffectsInterface - + +
+ __construct(resource|GdImage $resource) + +

Initialize the instance.

+
+ +
+
+ $this +
+
gamma(float $correction) -

Apply gamma correction

-
- EffectsInterface - + +

Apply gamma correction.

+
+ +
+
+ $this +
+
negative() -

Invert the colors of the image

-
- EffectsInterface - + +

Invert the colors of the image.

+
+ +
+
+ $this +
+
grayscale() -

Grayscale the image

-
- EffectsInterface - + +

Grayscale the image.

+
+ +
+
+ $this +
+
colorize(ColorInterface $color) -

Colorize the image

-
- EffectsInterface - + +

Colorize the image.

+
+ +
+
+ $this +
+
sharpen() -

Sharpens the image

-
- EffectsInterface - + +

Sharpens the image.

+
+ +
+
+ $this +
+
blur(float|int $sigma = 1) -

Blur the image

-
+ +

Blur the image.

+
+
+
+
+ $this +
+
+ brightness(int $brightness) + +

Changes the brightness of the image.

+
+
+
+
+ $this +
+
+ convolve(Matrix $matrix) + +

Convolves the image.

+
+
+

Details

-

-
at line 26
- public - __construct($resource) +
+
+

+
at line 36
+ + __construct(resource|GdImage $resource) +

-

-

-

-

-
+ + + +
+

Initialize the instance.

+

Parameters

- +
- + - +
resource|GdImage $resource -
@@ -142,259 +221,467 @@

Parameters

-

-
at line 34
- public EffectsInterface - gamma(float $correction) +

+
+

+
at line 46
+ $this + gamma(float $correction) +

-

Apply gamma correction

-

-

-
+ + + +
+

Apply gamma correction.

+

Parameters

- +
- +
float $correction -

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::gamma +
+
-

-
at line 46
- public EffectsInterface - negative() +

+
+

+
at line 60
+ $this + negative() +

-

Invert the colors of the image

-

-

-
+ + + +
+

Invert the colors of the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::negative +
+
-

-
at line 58
- public EffectsInterface - grayscale() +

+
+

+
at line 74
+ $this + grayscale() +

-

Grayscale the image

-

-

-
+ + + +
+

Grayscale the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::grayscale +
+
-

-
at line 70
- public EffectsInterface - colorize(ColorInterface $color) +

+
+

+
at line 88
+ $this + colorize(ColorInterface $color) +

-

Colorize the image

-

-

-
+ + + +
+

Colorize the image.

+

Parameters

- +
- +
ColorInterface $color -

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::colorize +
+
-

-
at line 86
- public EffectsInterface - sharpen() +

+
+

+
at line 106
+ $this + sharpen() +

-

Sharpens the image

-

-

-
+ + + +
+

Sharpens the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::sharpen +
+
-

-
at line 101
- public EffectsInterface - blur(float|int $sigma = 1) +

+
+

+
at line 123
+ $this + blur(float|int $sigma = 1) +

-

Blur the image

-

-

-
+ + + +
+

Blur the image.

+

Parameters

- +
+ + +
float|int $sigma
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +

See also

+ + + + EffectsInterface::blur + + + +
-
+ +
+
+ +
+
+

+
at line 137
+ $this + brightness(int $brightness) + +

+
+ + + +
+

Changes the brightness of the image.

+
+

Parameters

+ + + + + +
int$brightnessThe level of brightness (-100 (black) to 100 (white))

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
+ + + + +
RuntimeException
+ + +

See also

+ + - + EffectsInterface::brightness + + + +
RuntimeException -
+ +
+
+ +
+
+

+
at line 155
+ $this + convolve(Matrix $matrix) + +

+
+ + + +
+

Convolves the image.

+
+

Parameters

+ + + + + +
Matrix$matrixThe matrix from which derive the convolution kernel
+

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +

See also

+ + + + + + +
+ EffectsInterface::convolve +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gd/Font.html b/docs/API/API/Imagine/Gd/Font.html index 3fb0047d4..9605333b0 100644 --- a/docs/API/API/Imagine/Gd/Font.html +++ b/docs/API/API/Imagine/Gd/Font.html @@ -1,126 +1,245 @@ - - - - Imagine\Gd\Font | - - - -
- - -
- -
Class
-

Imagine\Gd\Font

+ + + + Imagine\Gd\Font | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Font extends AbstractFont

-
-

Font implementation using the GD library

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gd
  5. \
  6. Font
    7. +
+
+
+ +
+

+ Font + +

+
+ +

class + Font extends AbstractFont +

+ + + +
+

Font implementation using the GD library.

-

Methods

+ +

Properties

- +
- - - + + + - - - + + + - - - + + + - -
- + + protected string - __construct(string $file, integer $size, ColorInterface $color) -

Constructs a font with specified $file, $size and $color

- 		from AbstractFont$filefrom AbstractFont
- string + + protected int - getFile() -

Gets the fontfile for current font

- 		from AbstractFont$sizefrom AbstractFont
- integer - - getSize() -

Gets font's integer point size

+ 		+ protected ColorInterface from AbstractFont$colorfrom AbstractFont
+
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(string $file, int $size, ColorInterface $color) + +

Constructs a font with specified $file, $size and $color.

+
from AbstractFont
+
+
+
+ string +
+
+ getFile() + +

Gets the fontfile for current font.

+
from AbstractFont
+
+
+
+ int +
+
+ getSize() + +

Gets font's integer point size.

+
from AbstractFont
+
+
+
ColorInterface - - +
+
getColor() -

Gets font's color

- - from AbstractFont - - - + +

Gets font's color.

+
from AbstractFont
+
+
+
+ string +
+
+ wrapText(string $string, int $maxWidth, int $angle = 0) + +

Split a string into multiple lines so that it fits a specific width.

+
from AbstractFont
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractFont
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractFont
+
+
+
BoxInterface - - - box(string $string, integer $angle) -

Gets BoxInterface of font size on the image based on string and angle

- - - - +
+
+ box(string $string, int $angle = 0) + +

Gets BoxInterface of font size on the image based on string and angle.

+
+
+

Details

-

-
in AbstractFont at line 45
- public - __construct(string $file, integer $size, ColorInterface $color) +
+
+

+
in AbstractFont at line 54
+ + __construct(string $file, int $size, ColorInterface $color) +

-

Constructs a font with specified $file, $size and $color

-

The font size is to be specified in points (e.g. 10pt means 10)

-
+ + + +
+

Constructs a font with specified $file, $size and $color.

The font size is to be specified in points (e.g. 10pt means 10)

+

Parameters

- +
- + - + - + - +
string $file -
integerint $size -
ColorInterface $color -
@@ -130,131 +249,349 @@

Parameters

-

-
in AbstractFont at line 55
- final public string - getFile() +

+
+

+
in AbstractFont at line 66
+ final string + getFile() +

-

Gets the fontfile for current font

-

-

-
+ + + +
+

Gets the fontfile for current font.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ FontInterface::getFile +
+
-

-
in AbstractFont at line 63
- final public integer - getSize() +

+
+

+
in AbstractFont at line 76
+ final int + getSize() +

-

Gets font's integer point size

-

-

-
+ + + +
+

Gets font's integer point size.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ FontInterface::getSize +
+
-

-
in AbstractFont at line 71
- final public ColorInterface - getColor() +

+
+

+
in AbstractFont at line 86
+ final ColorInterface + getColor() +

-

Gets font's color

-

-

-
+ + + +
+

Gets font's color.

+

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ FontInterface::getColor +
+
-

-
at line 26
- public BoxInterface - box(string $string, integer $angle) +

+
+

+
in AbstractFont at line 96
+ string + wrapText(string $string, int $maxWidth, int $angle = 0) +

-

Gets BoxInterface of font size on the image based on string and angle

-

-

-
+ + + +
+

Split a string into multiple lines so that it fits a specific width.

+

Parameters

- +
- + + + + + + - + + + +
string $string -The text to be wrapped
int$maxWidthThe maximum width of the text
integerint $angle
+ + +

Return Value

+ + + + + + +
string
+ + + +

See also

+ + + + FontInterface::wrapText + +
-
+
+
+ +
+
+

+
in AbstractFont at line 135
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+

Return Value

- +
+ + + + +
ClassFactoryInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+ +
+
+ +
+
+

+
in AbstractFont at line 149
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+ +
+
+ +
+
+

+
at line 27
+ BoxInterface + box(string $string, int $angle = 0) + +

+
+ + + +
+

Gets BoxInterface of font size on the image based on string and angle.

+
+

Parameters

+ + + + + + + + + + + + +
string$string
int$angle
+ + +

Return Value

+ + - +
BoxInterface -
+

See also

+ + + + + + +
+ FontInterface::box +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gd/Image.html b/docs/API/API/Imagine/Gd/Image.html index e334281fe..314eb3c30 100644 --- a/docs/API/API/Imagine/Gd/Image.html +++ b/docs/API/API/Imagine/Gd/Image.html @@ -1,488 +1,815 @@ - - - - Imagine\Gd\Image | - - - -
- - -
- -
Class
-

Imagine\Gd\Image

+ + + + Imagine\Gd\Image | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Image extends AbstractImage

-
-

Image implementation using the GD library

-

-

+
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gd
  5. \
  6. Image
    7. +
+
+ +
+

+ Image + +

+
+ +

class + Image extends AbstractImage +

+ + + +
+

Image implementation using the GD library.

-

Methods

+ +

Properties

- +
- - - + + + - - -
- ManipulatorInterface + + protected MetadataBag - thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) -

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

- 		from AbstractImage$metadatafrom AbstractImage
- MetadataInterface - +
+ + +

Methods

+ +
+
+
+ ManipulatorInterface +
+
+ thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
from AbstractImage
+
+
+
+ int[] +
+
+ getAllThumbnailModes() + +

Get all the available thumbnail modes.

+
from AbstractImage
+
+
+
+ array +
+
+ updateSaveOptions(array $options) + +

Updates a given array of save options for backward compatibility with legacy names.

+
from AbstractImage
+
+
+
+ MetadataBag +
+
metadata() -

Returns the Image's meta data

- - from AbstractImage - - - + +

Returns the Image's meta data.

+
from AbstractImage
+
+
+
- - +
+
__clone() -

Assures the metadata instance will be cloned, too

- - from AbstractImage - - - + +

Clones all the resources associated to this instance.

+
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractImage
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractImage
+
+
+
- - - __construct(resource $resource, PaletteInterface $palette, MetadataBag $metadata) -

Constructs a new Image instance

- - - - - +
+
+ __construct(resource|GdImage $resource, PaletteInterface $palette, MetadataBag $metadata) + +

Constructs a new Image instance.

+
+
+
+
- - +
+
__destruct() -

Makes sure the current image resource is destroyed

- - - - - + +

Makes sure the current image resource is destroyed.

+
+
+
+
resource - - +
+
getGdResource() -

Returns Gd resource

- - - - - + +

Returns Gd resource.

+
+
+
+
ManipulatorInterface - - +
+
copy() -

Copies current source image into a new ImageInterface instance

- - - - - - ManipulatorInterface - - + +

Copies current source image into a new ImageInterface instance.

+
+
+
+
+ $this +
+
crop(PointInterface $start, BoxInterface $size) -

Crops a specified box out of the source image (modifies the source image) Returns cropped self

- - - - - - ManipulatorInterface - - - paste(ImageInterface $image, PointInterface $start) -

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

- - - - - - ManipulatorInterface - - + +

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+
+
+
+
+ $this +
+
+ paste(ImageInterface $image, PointInterface $start, int $alpha = 100) + +

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

+
+
+
+
+ $this +
+
resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) -

Resizes current image and returns self

- - - - - - ManipulatorInterface - - - rotate(integer $angle, ColorInterface $background = null) -

Rotates an image at the given angle.

- - - - - - ManipulatorInterface - - + +

Resizes current image and returns self.

+
+
+
+
+ $this +
+
+ rotate(int $angle, ColorInterface $background = null) + +

Rotates an image at the given angle.

+
+
+
+
+ $this +
+
save(string $path = null, array $options = array()) -

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

- - - - - - ManipulatorInterface - - + +

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

+
+
+
+
+ $this +
+
show(string $format, array $options = array()) -

Outputs the image content

- - - - - + +

Outputs the image content.

+
+
+
+
string - - +
+
get(string $format, array $options = array()) -

Returns the image content as a binary string

- - - - - + +

Returns the image content as a binary string.

+
+
+
+
string - - +
+
__toString() -

Returns the image content as a PNG binary string

- - - - - - ManipulatorInterface - - + +

Returns the image content as a PNG binary string.

+
+
+
+
+ $this +
+
flipHorizontally() -

Flips current image using horizontal axis

- - - - - - ManipulatorInterface - - + +

Flips current image using vertical axis.

+
+
+
+
+ $this +
+
flipVertically() -

Flips current image using vertical axis

- - - - - - ManipulatorInterface - - + +

Flips current image using horizontal axis.

+
+
+
+
+ $this +
+
strip() -

Remove all profiles and comments

- - - - - + +

Remove all profiles and comments.

+
+
+
+
DrawerInterface - - +
+
draw() -

Instantiates and returns a DrawerInterface instance for image drawing

- - - - - + +

Instantiates and returns a DrawerInterface instance for image drawing.

+
+
+
+
EffectsInterface - - +
+
effects() -

-

- - - - - + +

No description

+
+
+
+
+
BoxInterface - - +
+
getSize() -

Returns current image size

- - - - - - ManipulatorInterface - - + +

Returns current image size.

+
+
+
+
+ $this +
+
applyMask(ImageInterface $mask) -

Applies a given mask to current image's alpha channel

- - - - - - ManipulatorInterface - - + +

Applies a given mask to current image's alpha channel.

+
+
+
+
+ $this +
+
fill(FillInterface $fill) -

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

- - - - - + +

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+
+
+
+
ImageInterface - - +
+
mask() -

Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified

- - - - - - array - - + +

Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.

+
+
+
+
+ ColorInterface[] +
+
histogram() -

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances

- - - - - + +

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.

+
+
+
+
ColorInterface - - +
+
getColorAt(PointInterface $point) -

Returns color at specified positions of current image

- - - - - + +

Returns color at specified positions of current image.

+
+
+
+
LayersInterface - - +
+
layers() -

Returns the image layers when applicable.

- + +

Returns the image layers when applicable.

+
+
+
+
+ $this +
+
+ interlace(string $scheme) + +

Enables or disables interlacing.

+
+
+
+
+ PaletteInterface +
+
+ palette() + +

Return the current color palette.

+
+
+
+
+ $this +
+
+ profile(ProfileInterface $profile) + +

Applies a color profile on the Image.

+
+
+
+
+ $this +
+
+ usePalette(PaletteInterface $palette) + +

Set a palette for the image. Useful to change colorspace.

+
+
+
+ + +

Details

+ +
+
+

+
in AbstractImage at line 36
+ ManipulatorInterface + thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

+
+ + + +
+

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
+

Parameters

+ + + + + - - - + + + - - + + + + +
BoxInterface$size
- ImageInterface - - interlace(string $scheme) -

Enables or disables interlacing

- 		int|string$settingsOne or more of the ManipulatorInterface::THUMBNAIL_ flags (joined with |). It may be a string for backward compatibility with old constant values that were strings.
- PaletteInterface - - palette() -

Return the current color palette

- 		string$filterThe filter to use for resizing, one of ImageInterface::FILTER_*
+ + +

Return Value

+ + + + + + +
ManipulatorInterface
+ + +

Exceptions

+ + + + +
RuntimeException
+ + +

See also

+ + - - + +
- ImageInterface - - profile(ProfileInterface $profile) -

Applies a color profile on the Image

- 		+ ManipulatorInterface::thumbnail +
+ +
+
+ +
+
+

+
in AbstractImage at line 146
+ protected int[] + getAllThumbnailModes() + +

+
+ + + +
+

Get all the available thumbnail modes.

+
+ +

Return Value

+ + + + + + +
int[]
+ + + +
+
+ +
+
+

+
in AbstractImage at line 161
+ protected array + updateSaveOptions(array $options) + +

+
+ + + +
+

Updates a given array of save options for backward compatibility with legacy names.

+
+

Parameters

+ + - - + +
- ImageInterface - - usePalette(PaletteInterface $palette) -

Set a palette for the image.

- 		array$options
+ +

Return Value

+ + + + + + +
array
-

Details

+ + +
+
-

-
in AbstractImage at line 27
- public ManipulatorInterface - thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
in AbstractImage at line 176
+ MetadataBag + metadata() +

-

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

-

-

-
-

Parameters

+ + + +
+

Returns the Image's meta data.

+
+ +

Return Value

+ + + + + + +
MetadataBag
+ + + +

See also

- +
- - + ImageInterface::metadata + + +
BoxInterface$size -
+ +
+
+ +
+
+

+
at line 81
+ + __clone() + +

+
+ + + +
+

Clones all the resources associated to this instance.

+
+ + + +

See also

+ + - - - - - - - + AbstractImage::__clone + +
string$mode -
string$filterThe filter to use for resizing, one of ImageInterface::FILTER_*
+
+
+ +
+
+

+
in AbstractImage at line 196
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+

Return Value

- +
- - + +
ManipulatorInterface -ClassFactoryInterface
-

Exceptions

+ +

See also

- +
- + ClassFactoryAwareInterface::getClassFactory + +
RuntimeException -
-
-

-
in AbstractImage at line 103
- public MetadataInterface - metadata() +

+
+

+
in AbstractImage at line 210
+ $this + setClassFactory(ClassFactoryInterface $classFactory) +

-

Returns the Image's meta data

-

-

-
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+

Return Value

- +
- - + +
MetadataInterface -$this
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+
-

-
in AbstractImage at line 111
- public - __clone() +

+
+

+
at line 59
+ + __construct(resource|GdImage $resource, PaletteInterface $palette, MetadataBag $metadata) +

-

Assures the metadata instance will be cloned, too

-

-

-
- - -
-
+ -

-
at line 58
- public - __construct(resource $resource, PaletteInterface $palette, MetadataBag $metadata) -

-
-

Constructs a new Image instance

-

-

-
+
+

Constructs a new Image instance.

+

Parameters

- +
- + - + - + - +
resourceresource|GdImage $resource -
PaletteInterface $palette -
MetadataBag $metadata -
@@ -492,40 +819,49 @@

Parameters

-

-
at line 68
- public - __destruct() +

+
+

+
at line 69
+ + __destruct() +

-

Makes sure the current image resource is destroyed

-

-

-
+ + + +
+

Makes sure the current image resource is destroyed.

+
-

-
at line 80
- public resource - getGdResource() +

+
+

+
at line 102
+ resource + getGdResource() +

-

Returns Gd resource

-

-

-
+ + + +
+

Returns Gd resource.

+

Return Value

- +
- +
resource -
@@ -534,405 +870,499 @@

Return Value

-

-
at line 88
- final public ManipulatorInterface - copy() +

+
+

+
at line 112
+ final ManipulatorInterface + copy() +

-

Copies current source image into a new ImageInterface instance

-

-

-
+ + + +
+

Copies current source image into a new ImageInterface instance.

+

Return Value

- +
- +
ManipulatorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::copy +
+
-

-
at line 103
- final public ManipulatorInterface - crop(PointInterface $start, BoxInterface $size) +

+
+

+
at line 122
+ final $this + crop(PointInterface $start, BoxInterface $size) +

-

Crops a specified box out of the source image (modifies the source image) Returns cropped self

-

-

-
+ + + +
+

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+

Parameters

- +
- + - +
PointInterface $start -
BoxInterface $size -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + +
OutOfBoundsException -OutOfBoundsException
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::crop +
+
-

-
at line 128
- final public ManipulatorInterface - paste(ImageInterface $image, PointInterface $start) +

+
+

+
at line 150
+ final $this + paste(ImageInterface $image, PointInterface $start, int $alpha = 100) +

-

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

-

Returns source image

-
+ + + +
+

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

Returns source image

+

Parameters

- +
- + - + + + + + +
ImageInterface $image -
PointInterface $start -
int$alphaHow to paste the image, from 0 (fully transparent) to 100 (fully opaque)

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + + +
InvalidArgumentException -InvalidArgumentException
OutOfBoundsException -RuntimeException
+ + +

See also

+ + - + ManipulatorInterface::paste + +
RuntimeException -
-
-

-
at line 155
- final public ManipulatorInterface - resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
at line 189
+ final $this + resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Resizes current image and returns self

-

-

-
+ + + +
+

Resizes current image and returns self.

+

Parameters

- +
- + - +
BoxInterface $size -
string $filter -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::resize +
+
-

-
at line 186
- final public ManipulatorInterface - rotate(integer $angle, ColorInterface $background = null) +

+
+

+
at line 225
+ final $this + rotate(int $angle, ColorInterface $background = null) +

-

Rotates an image at the given angle.

-

Optional $background can be used to specify the fill color of the empty -area of rotated image.

-
+ + + +
+

Rotates an image at the given angle.

Optional $background can be used to specify the fill color of the empty +area of rotated image.

+

Parameters

- +
- + - + - +
integerint $angle -
ColorInterface $background -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::rotate +
+
-

-
at line 204
- final public ManipulatorInterface - save(string $path = null, array $options = array()) +

+
+

+
at line 248
+ final $this + save(string $path = null, array $options = array()) +

-

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

-

-

-
+ + + +
+

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

Please remark that bmp is supported by the GD driver only since PHP 7.2.

+

Parameters

- +
- + - +
string $path -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::save +
+
-

-
at line 229
- public ManipulatorInterface - show(string $format, array $options = array()) +

+
+

+
at line 275
+ $this + show(string $format, array $options = array()) +

-

Outputs the image content

-

-

-
+ + + +
+

Outputs the image content.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::show +
+
-

-
at line 241
- public string - get(string $format, array $options = array()) +

+
+

+
at line 289
+ string + get(string $format, array $options = array()) +

-

Returns the image content as a binary string

-

-

-
+ + + +
+

Returns the image content as a binary string.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
@@ -942,32 +1372,47 @@

Return Value

Exceptions

-
string binary
+
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::get +
+
-

-
at line 252
- public string - __toString() +

+
+

+
at line 302
+ string + __toString() +

-

Returns the image content as a PNG binary string

-

-

-
+ + + +
+

Returns the image content as a PNG binary string.

+

Return Value

- +
@@ -977,586 +1422,832 @@

Return Value

Exceptions

-
string binary
+
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::__toString +
+
-

-
at line 260
- final public ManipulatorInterface - flipHorizontally() +

+
+

+
at line 312
+ final $this + flipHorizontally() +

-

Flips current image using horizontal axis

-

-

-
+ + + +
+

Flips current image using vertical axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::flipHorizontally +
+
-

-
at line 283
- final public ManipulatorInterface - flipVertically() +

+
+

+
at line 342
+ final $this + flipVertically() +

-

Flips current image using vertical axis

-

-

-
+ + + +
+

Flips current image using horizontal axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::flipVertically +
+
-

-
at line 306
- final public ManipulatorInterface - strip() +

+
+

+
at line 372
+ final $this + strip() +

-

Remove all profiles and comments

-

-

-
+ + + +
+

Remove all profiles and comments.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::strip +
+
-

-
at line 315
- public DrawerInterface - draw() +

+
+

+
at line 383
+ DrawerInterface + draw() +

-

Instantiates and returns a DrawerInterface instance for image drawing

-

-

-
+ + + +
+

Instantiates and returns a DrawerInterface instance for image drawing.

+

Return Value

- +
- +
DrawerInterface -
+

See also

+ + + + + + +
+ ImageInterface::draw +
+
-

-
at line 323
- public EffectsInterface - effects() +

+
+

+
at line 393
+ EffectsInterface + effects() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
EffectsInterface -
+

See also

+ + + + + + +
+ ImageInterface::effects +
+
-

-
at line 331
- public BoxInterface - getSize() +

+
+

+
at line 403
+ BoxInterface + getSize() +

-

Returns current image size

-

-

-
+ + + +
+

Returns current image size.

+

Return Value

- +
- +
BoxInterface -
+

See also

+ + + + + + +
+ ImageInterface::getSize +
+
-

-
at line 339
- public ManipulatorInterface - applyMask(ImageInterface $mask) +

+
+

+
at line 413
+ $this + applyMask(ImageInterface $mask) +

-

Applies a given mask to current image's alpha channel

-

-

-
+ + + +
+

Applies a given mask to current image's alpha channel.

+

Parameters

- +
- +
ImageInterface $mask -

Return Value

- +
- - + +
ManipulatorInterface -$this
+

See also

+ + + + + + +
+ ManipulatorInterface::applyMask +
+
-

-
at line 371
- public ManipulatorInterface - fill(FillInterface $fill) +

+
+

+
at line 447
+ $this + fill(FillInterface $fill) +

-

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

-

-

-
+ + + +
+

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+

Parameters

- +
- +
FillInterface $fill -

Return Value

- +
- - + +
ManipulatorInterface -$this
+

See also

+ + + + + + +
+ ManipulatorInterface::fill +
+
-

-
at line 389
- public ImageInterface - mask() +

+
+

+
at line 467
+ ImageInterface + mask() +

-

Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified

-

-

-
+ + + +
+

Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.

+

Return Value

- +
- +
ImageInterface -
+

See also

+ + + + + + +
+ ImageInterface::mask +
+
-

-
at line 403
- public array - histogram() +

+
+

+
at line 483
+ ColorInterface[] + histogram() +

-

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances

-

-

-
+ + + +
+

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.

+

Return Value

- +
- - + +
array -ColorInterface[]
+

See also

+ + + + + + +
+ ImageInterface::histogram +
+
-

-
at line 420
- public ColorInterface - getColorAt(PointInterface $point) +

+
+

+
at line 502
+ ColorInterface + getColorAt(PointInterface $point) +

-

Returns color at specified positions of current image

-

-

-
+ + + +
+

Returns color at specified positions of current image.

+

Parameters

- +
- +
PointInterface $point -

Return Value

- +
- +
ColorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::getColorAt +
+
-

-
at line 435
- public LayersInterface - layers() +

+
+

+
at line 519
+ LayersInterface + layers() +

-

Returns the image layers when applicable.

-

-

-
+ + + +
+

Returns the image layers when applicable.

+

Return Value

- +
- +
LayersInterface -

Exceptions

- +
- + - +
RuntimeExceptionRuntimeException In case the layer can not be returned
OutOfBoundsExceptionOutOfBoundsException In case the index is not a valid value
+

See also

+ + + + + + +
+ ImageInterface::layers +
+
-

-
at line 447
- public ImageInterface - interlace(string $scheme) +

+
+

+
at line 533
+ $this + interlace(string $scheme) +

-

Enables or disables interlacing

-

-

-
+ + + +
+

Enables or disables interlacing.

+

Parameters

- +
- +
string $scheme -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException When an unsupported Interface type is supplied
+

See also

+ + + + + + +
+ ImageInterface::interlace +
+
-

-
at line 468
- public PaletteInterface - palette() +

+
+

+
at line 556
+ PaletteInterface + palette() +

-

Return the current color palette

-

-

-
+ + + +
+

Return the current color palette.

+

Return Value

- +
- +
PaletteInterface -
+

See also

+ + + + + + +
+ ImageInterface::palette +
+
-

-
at line 476
- public ImageInterface - profile(ProfileInterface $profile) +

+
+

+
at line 566
+ $this + profile(ProfileInterface $profile) +

-

Applies a color profile on the Image

-

-

-
+ + + +
+

Applies a color profile on the Image.

+

Parameters

- +
- +
ProfileInterface $profile -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::profile +
+
-

-
at line 484
- public ImageInterface - usePalette(PaletteInterface $palette) +

+
+

+
at line 576
+ $this + usePalette(PaletteInterface $palette) +

-

Set a palette for the image.

-

Useful to change colorspace.

-
+ + + +
+

Set a palette for the image. Useful to change colorspace.

+

Parameters

- +
- +
PaletteInterface $palette -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::usePalette +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gd/Imagine.html b/docs/API/API/Imagine/Gd/Imagine.html index cc44d45a3..ae3f58d97 100644 --- a/docs/API/API/Imagine/Gd/Imagine.html +++ b/docs/API/API/Imagine/Gd/Imagine.html @@ -1,215 +1,442 @@ - - - - Imagine\Gd\Imagine | - - - -
- - -
- -
Class
-

Imagine\Gd\Imagine

+ + + + Imagine\Gd\Imagine | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Imagine extends AbstractImagine

-
-

Imagine implementation using the GD library

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gd
  5. \
  6. Imagine
    7. +
+
+
+ +
+

+ Imagine + +

+
+ +

class + Imagine extends AbstractImagine +

+ + + + +
+

Imagine implementation using the GD library.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +

Loads an image from a resource $resource.

+
+ +
+
+ FontInterface +
+
+ font(string $file, int $size, ColorInterface $color) + +

Constructs a font with specified $file, $size and $color.

+
+
+ + + +

Details

+ +
+
+

+
in AbstractImagine at line 36
+ $this + setMetadataReader(MetadataReaderInterface $metadataReader) + +

+
+ + + +
+

Set the object to be used to read image metadata.

+
+

Parameters

+ +
- ImagineInterface - +
+
+
+ $this +
+
setMetadataReader(MetadataReaderInterface $metadataReader) -

-

-
from AbstractImagine
+ +

Set the object to be used to read image metadata.

+
from AbstractImagine
+ +
+
MetadataReaderInterface -
+ +
getMetadataReader() -

-

-
from AbstractImagine
+ +

Get the object to be used to read image metadata.

+
from AbstractImagine
+ +
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractImagine
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractImagine
+
+
+
+ string +
+
+ checkPath(string|object $path) + +

Checks a path that could be used with ImagineInterface::open and returns +a proper string.

+
from AbstractImagine
+
+
+
-
+ +
__construct() -

-

-
+ +

Initialize the class.

+
+ +
+
ImageInterface -
+ +
create(BoxInterface $size, ColorInterface $color = null) -

Creates a new empty image with an optional background color

-
+ +

Creates a new empty image with an optional background color.

+
+ +
+
ImageInterface -
- open(string $path) -

Opens an existing image from $path

-
+ +
+ open(string|LoaderInterface|mixed $path) + +

Opens an existing image from $path.

+
+ +
+
ImageInterface -
+ +
load(string $string) -

Loads an image from a binary $string

-
+ +

Loads an image from a binary $string.

+
+ +
+
ImageInterface -
+ +
read(resource $resource) -

Loads an image from a resource $resource

-
+ + + +
MetadataReaderInterface$metadataReader
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + - - +
- FontInterface - - font(string $file, integer $size, ColorInterface $color) -

Constructs a font with specified $file, $size and $color

- 		+ ImagineInterface::setMetadataReader +
+
+
-

Details

+
+
+

+
in AbstractImagine at line 48
+ MetadataReaderInterface + getMetadataReader() + +

+
+ + + +
+

Get the object to be used to read image metadata.

+
+ +

Return Value

+ + + + + + +
MetadataReaderInterface
+ + + +

See also

+ + + + + + +
+ ImagineInterface::getMetadataReader +
-

-
in AbstractImagine at line 27
- public ImagineInterface - setMetadataReader(MetadataReaderInterface $metadataReader) +

+
+ +
+
+

+
in AbstractImagine at line 62
+ $this + setClassFactory(ClassFactoryInterface $classFactory) +

-

-

-

-

-
+ + + +
+

Set the class factory instance to be used.

+

Parameters

- +
- - - + + +
MetadataReaderInterface$metadataReader -ClassFactoryInterface$classFactory

Return Value

- +
- - + +
ImagineInterface -$this
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+
-

-
in AbstractImagine at line 37
- public MetadataReaderInterface - getMetadataReader() +

+
+

+
in AbstractImagine at line 74
+ ClassFactoryInterface + getClassFactory() +

-

-

-

-

-
+ + + +
+

Get the class factory instance to be used.

+

Return Value

- +
- - + +
MetadataReaderInterface -ClassFactoryInterface
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+
-

-
at line 37
- public - __construct() +

+
+

+
in AbstractImagine at line 93
+ protected string + checkPath(string|object $path) +

-

-

-

-

-
+ + +
+

Checks a path that could be used with ImagineInterface::open and returns +a proper string.

+
+

Parameters

+ + + + + + + +
string|object$path
+ + +

Return Value

+ + + + + + +
string
+

Exceptions

- +
- - + +
RuntimeException -InvalidArgumentExceptionin case the given path is invalid
@@ -217,257 +444,348 @@

Exceptions

-

-
at line 46
- public ImageInterface - create(BoxInterface $size, ColorInterface $color = null) +

+
+

+
at line 35
+ + __construct() +

-

Creates a new empty image with an optional background color

-

-

-
+ + + +
+

Initialize the class.

+
+ + + +
+
+ +
+
+

+
at line 45
+ ImageInterface + create(BoxInterface $size, ColorInterface $color = null) + +

+
+ + + +
+

Creates a new empty image with an optional background color.

+

Parameters

- +
- + - +
BoxInterface $size -
ColorInterface $color -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + + - - + +
InvalidArgumentException -InvalidArgumentException
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::create +
+
-

-
at line 84
- public ImageInterface - open(string $path) +

+
+

+
at line 85
+ ImageInterface + open(string|LoaderInterface|mixed $path) +

-

Opens an existing image from $path

-

-

-
+ + + +
+

Opens an existing image from $path.

+

Parameters

- +
- + - +
stringstring|LoaderInterface|mixed $path -the file path, a LoaderInterface instance, or an object whose string representation is the image path

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::open +
+
-

-
at line 105
- public ImageInterface - load(string $string) +

+
+

+
at line 106
+ ImageInterface + load(string $string) +

-

Loads an image from a binary $string

-

-

-
+ + + +
+

Loads an image from a binary $string.

+

Parameters

- +
- +
string $string -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::load +
+
-

-
at line 113
- public ImageInterface - read(resource $resource) +

+
+

+
at line 116
+ ImageInterface + read(resource $resource) +

-

Loads an image from a resource $resource

-

-

-
+ + + +
+

Loads an image from a resource $resource.

+

Parameters

- +
- +
resource $resource -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::read +
+
-

-
at line 131
- public FontInterface - font(string $file, integer $size, ColorInterface $color) +

+
+

+
at line 136
+ FontInterface + font(string $file, int $size, ColorInterface $color) +

-

Constructs a font with specified $file, $size and $color

-

The font size is to be specified in points (e.g. 10pt means 10)

-
+ + + +
+

Constructs a font with specified $file, $size and $color.

The font size is to be specified in points (e.g. 10pt means 10)

+

Parameters

- +
- + - + - + - +
string $file -
integerint $size -
ColorInterface $color -

Return Value

- +
- +
FontInterface -
+

See also

+ + + + + + +
+ ImagineInterface::font +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gd/Layers.html b/docs/API/API/Imagine/Gd/Layers.html index 1350bc3ed..e8e323a21 100644 --- a/docs/API/API/Imagine/Gd/Layers.html +++ b/docs/API/API/Imagine/Gd/Layers.html @@ -1,591 +1,893 @@ - - - - Imagine\Gd\Layers | - - - -
- - -
- -
Class
-

Imagine\Gd\Layers

+ + + + Imagine\Gd\Layers | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Layers extends AbstractLayers

+
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gd
  5. \
  6. Layers
    7. +
+
+
+ +
+

+ Layers + +

+
+ +

class + Layers extends AbstractLayers +

+ + + + +

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- LayersInterface - +
+
+
+ $this +
+
add(ImageInterface $image) -

Adds an image at the end of the layers stack

-
from AbstractLayers
- LayersInterface - - set(integer $offset, ImageInterface $image) -

Set an image at offset

- 		from AbstractLayers
- LayersInterface - - remove(integer $offset) -

Removes the image at offset

- 		from AbstractLayers
+ +

Adds an image at the end of the layers stack.

+
from AbstractLayers
+ +
+
+ $this +
+
+ set(int $offset, ImageInterface $image) + +

Set an image at offset.

+
from AbstractLayers
+
+
+
+ $this +
+
+ remove(int $offset) + +

Removes the image at offset.

+
from AbstractLayers
+
+
+
ImageInterface -
- get(integer $offset) -

Returns the image at offset

- 		from AbstractLayers
- Boolean - - has(integer $offset) -

Returns true if a layer at offset is preset

- 		from AbstractLayers
+ +
+ get(int $offset) + +

Returns the image at offset.

+
from AbstractLayers
+ +
+
+ bool +
+
+ has(int $offset) + +

Returns true if a layer at offset is preset.

+
from AbstractLayers
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractLayers
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractLayers
+
+
+
-
- __construct(Image $image, PaletteInterface $palette, $resource) -

-

-
+ +
+ __construct(Image $image, PaletteInterface $palette, resource|GdImage $resource, int $initialOffset = 0) + +

No description

+
+
+ +
+
-
+ +
merge() -

Merge layers into the original objects

-
- - + +

Merge layers into the original objects.

+
+ +
+
+ $this +
+
coalesce() -

Coalesce layers.

-
- LayersInterface - - animate(string $format, integer $delay, integer $loops) -

Animates layers

-
+ +

Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.

+
+ +
+
+ $this +
+
+ animate(string $format, int $delay, int $loops) + +

Animates layers.

+
+
+
+
-
+ +
current() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
key() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
next() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
rewind() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
valid() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
count() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetExists($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetGet($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetSet($offset, $value) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetUnset($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+
+

Details

-

-
in AbstractLayers at line 19
- public LayersInterface - add(ImageInterface $image) +
+
+

+
in AbstractLayers at line 30
+ $this + add(ImageInterface $image) +

-

Adds an image at the end of the layers stack

-

-

-
+ + + +
+

Adds an image at the end of the layers stack.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ LayersInterface::add +
+
-

-
in AbstractLayers at line 29
- public LayersInterface - set(integer $offset, ImageInterface $image) +

+
+

+
in AbstractLayers at line 42
+ $this + set(int $offset, ImageInterface $image) +

-

Set an image at offset

-

-

-
+ + + +
+

Set an image at offset.

+

Parameters

- +
- + - + - +
integerint $offset -
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
OutOfBoundsException -OutOfBoundsException
+

See also

+ + + + + + +
+ LayersInterface::set +
+
-

-
in AbstractLayers at line 39
- public LayersInterface - remove(integer $offset) +

+
+

+
in AbstractLayers at line 54
+ $this + remove(int $offset) +

-

Removes the image at offset

-

-

-
+ + + +
+

Removes the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
+

See also

+ + + + + + +
+ LayersInterface::remove +
+
-

-
in AbstractLayers at line 49
- public ImageInterface - get(integer $offset) +

+
+

+
in AbstractLayers at line 66
+ ImageInterface + get(int $offset) +

-

Returns the image at offset

-

-

-
+ + + +
+

Returns the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
+

See also

+ + + + + + +
+ LayersInterface::get +
+
-

-
in AbstractLayers at line 57
- public Boolean - has(integer $offset) +

+
+

+
in AbstractLayers at line 76
+ bool + has(int $offset) +

-

Returns true if a layer at offset is preset

-

-

-
+ + + +
+

Returns true if a layer at offset is preset.

+

Parameters

- +
- + + + +
integerint $offset
+ + +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + LayersInterface::has + + + +
-
+ +
+
+ +
+
+

+
in AbstractLayers at line 86
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + +
ClassFactoryInterface$classFactory

Return Value

- +
- - + +
Boolean -$this
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+
-

-
at line 27
- public - __construct(Image $image, PaletteInterface $palette, $resource) +

+
+

+
in AbstractLayers at line 98
+ ClassFactoryInterface + getClassFactory() +

-

-

-

-

-
+ + + +
+

Get the class factory instance to be used.

+
+ +

Return Value

+ + + + + + +
ClassFactoryInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+ +
+
+ +
+
+

+
at line 51
+ + __construct(Image $image, PaletteInterface $palette, resource|GdImage $resource, int $initialOffset = 0) + +

+
+ + + +

Parameters

- +
- + - + - + - + + + + + +
Image $image -
PaletteInterface $palette -
resource|GdImage $resource -
int$initialOffset
+

Exceptions

+ + + + + + +
RuntimeException
+
-

-
at line 42
- public - merge() +

+
+

+
at line 68
+ + merge() +

-

Merge layers into the original objects

-

-

-
+ + + +
+

Merge layers into the original objects.

+

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ LayersInterface::merge +
+
-

-
at line 49
- public - coalesce() +

+
+

+
at line 77
+ $this + coalesce() +

-

Coalesce layers.

-

Each layer in the sequence is the same size as the first and composited with the next layer in -the sequence.

-
+ + +
+

Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.

+
+ +

Return Value

+ + + + + + +
$this
+ +

Exceptions

+ + + + + + +
NotSupportedException
+ +

See also

+ + + + + + +
+ LayersInterface::coalesce +
+
-

-
at line 56
- public LayersInterface - animate(string $format, integer $delay, integer $loops) +

+
+

+
at line 87
+ $this + animate(string $format, int $delay, int $loops) +

-

Animates layers

-

-

-
+ + + +
+

Animates layers.

+

Parameters

- +
- + - + @@ -594,246 +896,418 @@

Parameters

Return Value

-
string $format The output output format
integerint $delay The delay in milliseconds between two frames
integerint $loops The number of loops, 0 means infinite
+
- - + +
LayersInterface -$this

Exceptions

- +
- + - +
InvalidArgumentExceptionInvalidArgumentException In case an invalid argument is provided
RuntimeExceptionRuntimeException In case the driver fails to animate
+

See also

+ + + + + + +
+ LayersInterface::animate +
+
-

-
at line 64
- public - current() +

+
+

+
at line 97
+ + current() +

-

{@inheritdoc}

-

-

-
+ + +
+

{@inheritdoc}

+
+ +

See also

+ + + + + + +
+ \Iterator::current() +
+
-

-
at line 72
- public - key() +

+
+

+
at line 107
+ + key() +

-

{@inheritdoc}

-

-

-
+ + +
+

{@inheritdoc}

+
+ +

See also

+ + + + + + +
+ \Iterator::key() +
+
-

-
at line 80
- public - next() +

+
+

+
at line 117
+ + next() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Iterator::next() +
+
-

-
at line 88
- public - rewind() +

+
+

+
at line 127
+ + rewind() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Iterator::rewind() +
+
-

-
at line 96
- public - valid() +

+
+

+
at line 137
+ + valid() +

-

{@inheritdoc}

-

-

-
+ + +
+

{@inheritdoc}

+
+ +

See also

+ + + + + + +
+ \Iterator::valid() +
+
-

-
at line 104
- public - count() +

+
+

+
at line 147
+ + count() +

-

{@inheritdoc}

-

-

-
+ + +
+

{@inheritdoc}

+
+ +

See also

+ + + + + + +
+ \Countable::count() +
+
-

-
at line 112
- public - offsetExists($offset) +

+
+

+
at line 157
+ + offsetExists($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetExists() +
+
-

-
at line 120
- public - offsetGet($offset) +

+
+

+
at line 167
+ + offsetGet($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetGet() +
+
-

-
at line 132
- public - offsetSet($offset, $value) +

+
+

+
at line 181
+ + offsetSet($offset, $value) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- + - +
$offset -
$value -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetSet() +
+
-

-
at line 140
- public - offsetUnset($offset) +

+
+

+
at line 191
+ + offsetUnset($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetUnset() +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gd/namespace-frame.html b/docs/API/API/Imagine/Gd/namespace-frame.html deleted file mode 100644 index 053f5f111..000000000 --- a/docs/API/API/Imagine/Gd/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Gd | - - - diff --git a/docs/API/API/Imagine/Gmagick.html b/docs/API/API/Imagine/Gmagick.html index 55ffe856d..b07075fe8 100644 --- a/docs/API/API/Imagine/Gmagick.html +++ b/docs/API/API/Imagine/Gmagick.html @@ -1,60 +1,149 @@ - - - - Imagine\Gmagick | - - - -
- - -
- -
Namespace
-

Imagine\Gmagick

+ + + + Imagine\Gmagick | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Gmagick
  5. \
    6. +
+
+
+ +
+

Imagine\Gmagick

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
DrawerDrawer implementation using the Gmagick PHP extension
EffectsEffects implementation using the Gmagick PHP extension
FontFont implementation using the Gmagick PHP extension
ImageImage implementation using the Gmagick PHP extension
ImagineImagine implementation using the Gmagick PHP extension
Layers -
+ + +

Classes

+ +
+
+
+ Drawer + +
+
+ Drawer implementation using the Gmagick PHP extension. +
+
+
+
+ Effects + +
+
+ Effects implementation using the Gmagick PHP extension. +
+
+
+
+ Font + +
+
+ Font implementation using the Gmagick PHP extension. +
+
+
+
+ Image + +
+
+ Image implementation using the Gmagick PHP extension. +
+
+
+
+ Imagine + +
+
+ Imagine implementation using the Gmagick PHP extension. +
+
+
+
+ Layers + +
+
+ +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gmagick/Drawer.html b/docs/API/API/Imagine/Gmagick/Drawer.html index 460e2c721..867c0874e 100644 --- a/docs/API/API/Imagine/Gmagick/Drawer.html +++ b/docs/API/API/Imagine/Gmagick/Drawer.html @@ -1,728 +1,1051 @@ - - - - Imagine\Gmagick\Drawer | - - - -
- - -
- -
Class
-

Imagine\Gmagick\Drawer

+ + + + Imagine\Gmagick\Drawer | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gmagick
  5. \
  6. Drawer
    7. +
+
+
+ +
+

+ Drawer + +

-
-

class + +

class Drawer implements - DrawerInterface

+ DrawerInterface +

+ + +
-

Drawer implementation using the Gmagick PHP extension

-

-

-
+

Drawer implementation using the Gmagick PHP extension.

+

Methods

- - - - - - + +
+ __construct(Gmagick $gmagick) + +

No description

+
+
+ +
+
+ $this +
+
+ arc(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, int $thickness = 1) + +

Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.

+
+
+
+
+ $this +
+
+ chord(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Same as arc, but also connects end points with a straight line.

+
+
+
+
+ $this +
+
+ circle(PointInterface $center, int $radius, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws and circle with center at the given x, y coordinates, and given radius.

+
+
+
+
+ $this +
+
+ ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws and ellipse with center at the given x, y coordinates, and given width and height.

+
+
+
+
+ $this +
+
+ line(PointInterface $start, PointInterface $end, ColorInterface $color, int $thickness = 1) + +

Draws a line from start(x, y) to end(x, y) coordinates.

+
+
+
+
+ $this +
+
+ pieSlice(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Same as arc, but connects end points and the center.

+
+
+
+
+ $this +
+
+ dot(PointInterface $position, ColorInterface $color) + +

Places a one pixel point at specific coordinates and fills it with +specified color.

+
+
+
+
+ $this +
+
+ rectangle(PointInterface $leftTop, PointInterface $rightBottom, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.

+
+
+
+
+ $this +
+
+ polygon(array $coordinates, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.

+
+
+
+
+ $this +
+
+ text(string $string, AbstractFont $font, PointInterface $position, int $angle = 0, int $width = null) + +

Annotates image with specified text at a given position starting on the top left of the final text box.

+
+
+ + + +

Details

+ +
+
+

+
at line 37
+ + __construct(Gmagick $gmagick) + +

+
+ + + +
+

Parameters

+ +
+
+
+
-
- __construct(Gmagick $gmagick) -

-

-
- - + + +
- DrawerInterface - - arc(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, integer $thickness = 1) -

Draws an arc on a starting at a given x, y coordinates under a given start and end angles

- 		Gmagick$gmagick
+ + + + +
+
+ +
+
+

+
at line 47
+ $this + arc(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, int $thickness = 1) + +

+
+ + + +
+

Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.

+
+

Parameters

+ + - - + + - - + + - - + + - - + + - - + + - - + + +
- DrawerInterface - - chord(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Same as arc, but also connects end points with a straight line

- 		PointInterface$center
- DrawerInterface - - ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Draws and ellipse with center at the given x, y coordinates, and given width and height

- 		BoxInterface$size
- DrawerInterface - - line(PointInterface $start, PointInterface $end, ColorInterface $color, integer $thickness = 1) -

Draws a line from start(x, y) to end(x, y) coordinates

- 		int$start
- DrawerInterface - - pieSlice(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Same as arc, but connects end points and the center

- 		int$end
- DrawerInterface - - dot(PointInterface $position, ColorInterface $color) -

Places a one pixel point at specific coordinates and fills it with specified color

- 		ColorInterface$color
- DrawerInterface - - polygon(array $coordinates, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Draws a polygon using array of x, y coordinates.

- 		int$thickness
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + - - +
- DrawerInterface - - text(string $string, AbstractFont $font, PointInterface $position, integer $angle, integer $width = null) -

Annotates image with specified text at a given position starting on the top left of the final text box

- 		RuntimeException
+ +

See also

-

Details

- -

-
at line 37
- public - __construct(Gmagick $gmagick) -

-
-

-

-

-

-
-

Parameters

- - +
- - + DrawerInterface::arc + +
Gmagick$gmagick -
- - -
-

-
at line 45
- public DrawerInterface - arc(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, integer $thickness = 1) +

+
+

+
at line 91
+ $this + chord(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws an arc on a starting at a given x, y coordinates under a given start and end angles

-

-

-
+ + + +
+

Same as arc, but also connects end points with a straight line.

+

Parameters

- +
- + - + - + - + - + - + - + + + + + + - + - +
PointInterface $center -
BoxInterface $size -
integerint $start -
integerint $end -
ColorInterface $color -
bool$fill
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::chord +
+
-

-
at line 83
- public DrawerInterface - chord(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 141
+ $this + circle(PointInterface $center, int $radius, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Same as arc, but also connects end points with a straight line

-

-

-
+ + + +
+

Draws and circle with center at the given x, y coordinates, and given radius.

+

Parameters

- +
- - - - - - - - - - - + - - - + + + - + - + - + - + - +
PointInterface $center -
BoxInterface$size -
integer$start -
integer$end -int$radius
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::circle +
+
-

-
at line 127
- public DrawerInterface - ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 153
+ $this + ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws and ellipse with center at the given x, y coordinates, and given width and height

-

-

-
+ + + +
+

Draws and ellipse with center at the given x, y coordinates, and given width and height.

+

Parameters

- +
- + - + - + - + - + - + - +
PointInterface $center -
BoxInterface $size -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::ellipse +
+
-

-
at line 168
- public DrawerInterface - line(PointInterface $start, PointInterface $end, ColorInterface $color, integer $thickness = 1) +

+
+

+
at line 200
+ $this + line(PointInterface $start, PointInterface $end, ColorInterface $color, int $thickness = 1) +

-

Draws a line from start(x, y) to end(x, y) coordinates

-

-

-
+ + + +
+

Draws a line from start(x, y) to end(x, y) coordinates.

+

Parameters

- +
- + - + - + - + - +
PointInterface $start -
PointInterface $end -
ColorInterface $color -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this
+

See also

+ + + + + + +
+ DrawerInterface::line +
+
-

-
at line 199
- public DrawerInterface - pieSlice(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 237
+ $this + pieSlice(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Same as arc, but connects end points and the center

-

-

-
+ + + +
+

Same as arc, but connects end points and the center.

+

Parameters

- +
- + - + - + - + - + - + - + - + - + - + - +
PointInterface $center -
BoxInterface $size -
integerint $start -
integerint $end -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::pieSlice +
+
-

-
at line 233
- public DrawerInterface - dot(PointInterface $position, ColorInterface $color) +

+
+

+
at line 277
+ $this + dot(PointInterface $position, ColorInterface $color) +

-

Places a one pixel point at specific coordinates and fills it with specified color

-

-

-
+ + + +
+

Places a one pixel point at specific coordinates and fills it with +specified color.

+

Parameters

- +
- + - +
PointInterface $position -
ColorInterface $color -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
+ + + + +
RuntimeException
+ + +

See also

+ + - + DrawerInterface::dot + +
RuntimeException -
+
+
+ +
+
+

+
at line 305
+ $this + rectangle(PointInterface $leftTop, PointInterface $rightBottom, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

+
+ + +
+

Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
PointInterface$leftTop
PointInterface$rightBottom
ColorInterface$color
bool$fill
int$thickness
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +

See also

+ + + + + + +
+ DrawerInterface::rectangle +
+
-

-
at line 259
- public DrawerInterface - polygon(array $coordinates, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 342
+ $this + polygon(array $coordinates, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws a polygon using array of x, y coordinates.

-

Must contain at least -three coordinates

-
+ + + +
+

Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.

+

Parameters

- +
- + - + - + - + - + - +
array $coordinates -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::polygon +
+
-

-
at line 297
- public DrawerInterface - text(string $string, AbstractFont $font, PointInterface $position, integer $angle, integer $width = null) +

+
+

+
at line 386
+ $this + text(string $string, AbstractFont $font, PointInterface $position, int $angle = 0, int $width = null) +

-

Annotates image with specified text at a given position starting on the top left of the final text box

-

The rotation is done CW

-
+ + + +
+

Annotates image with specified text at a given position starting on the top left of the final text box.

The rotation is done CW

+

Parameters

- +
- + - + - + - + - + - + - +
string $string -
AbstractFont $font -
PointInterface $position -
integerint $angle -
integerint $width -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::text +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gmagick/Effects.html b/docs/API/API/Imagine/Gmagick/Effects.html index 684860da3..85b99daef 100644 --- a/docs/API/API/Imagine/Gmagick/Effects.html +++ b/docs/API/API/Imagine/Gmagick/Effects.html @@ -1,138 +1,217 @@ - - - - Imagine\Gmagick\Effects | - - - -
- - -
- -
Class
-

Imagine\Gmagick\Effects

+ + + + Imagine\Gmagick\Effects | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gmagick
  5. \
  6. Effects
    7. +
+
+
+ +
+

+ Effects + +

+
+ +

class Effects implements - EffectsInterface

+ EffectsInterface +

+ + +
-

Effects implementation using the Gmagick PHP extension

-

-

-
+

Effects implementation using the Gmagick PHP extension.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(Gmagick $gmagick) -

-

-
- EffectsInterface - + +
+ __construct(Gmagick $gmagick) + +

Initialize the instance.

+
+ +
+
+ $this +
+
gamma(float $correction) -

Apply gamma correction

-
- EffectsInterface - + +

Apply gamma correction.

+
+ +
+
+ $this +
+
negative() -

Invert the colors of the image

-
- EffectsInterface - + +

Invert the colors of the image.

+
+ +
+
+ $this +
+
grayscale() -

Grayscale the image

-
- EffectsInterface - + +

Grayscale the image.

+
+ +
+
+ $this +
+
colorize(ColorInterface $color) -

Colorize the image

-
- EffectsInterface - + +

Colorize the image.

+
+ +
+
+ $this +
+
sharpen() -

Sharpens the image

-
- EffectsInterface - + +

Sharpens the image.

+
+ +
+
+ $this +
+
blur(float|int $sigma = 1) -

Blur the image

-
+ +

Blur the image.

+
+
+
+
+ $this +
+
+ brightness(int $brightness) + +

Changes the brightness of the image.

+
+
+
+
+ $this +
+
+ convolve(Matrix $matrix) + +

Convolves the image.

+
+
+

Details

-

-
at line 26
- public - __construct(Gmagick $gmagick) +
+
+

+
at line 36
+ + __construct(Gmagick $gmagick) +

-

-

-

-

-
+ + + +
+

Initialize the instance.

+

Parameters

- +
- + - +
GmagickGmagick $gmagick -
@@ -142,259 +221,467 @@

Parameters

-

-
at line 34
- public EffectsInterface - gamma(float $correction) +

+
+

+
at line 46
+ $this + gamma(float $correction) +

-

Apply gamma correction

-

-

-
+ + + +
+

Apply gamma correction.

+

Parameters

- +
- +
float $correction -

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::gamma +
+
-

-
at line 48
- public EffectsInterface - negative() +

+
+

+
at line 62
+ $this + negative() +

-

Invert the colors of the image

-

-

-
+ + + +
+

Invert the colors of the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::negative +
+
-

-
at line 66
- public EffectsInterface - grayscale() +

+
+

+
at line 82
+ $this + grayscale() +

-

Grayscale the image

-

-

-
+ + + +
+

Grayscale the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::grayscale +
+
-

-
at line 80
- public EffectsInterface - colorize(ColorInterface $color) +

+
+

+
at line 98
+ $this + colorize(ColorInterface $color) +

-

Colorize the image

-

-

-
+ + + +
+

Colorize the image.

+

Parameters

- +
- +
ColorInterface $color -

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::colorize +
+
-

-
at line 88
- public EffectsInterface - sharpen() +

+
+

+
at line 108
+ $this + sharpen() +

-

Sharpens the image

-

-

-
+ + + +
+

Sharpens the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::sharpen +
+
-

-
at line 96
- public EffectsInterface - blur(float|int $sigma = 1) +

+
+

+
at line 118
+ $this + blur(float|int $sigma = 1) +

-

Blur the image

-

-

-
+ + + +
+

Blur the image.

+

Parameters

- +
+ + +
float|int $sigma
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +

See also

+ + + + EffectsInterface::blur + + + +
-
+ +
+
+ +
+
+

+
at line 134
+ $this + brightness(int $brightness) + +

+
+ + + +
+

Changes the brightness of the image.

+
+

Parameters

+ + + + + +
int$brightnessThe level of brightness (-100 (black) to 100 (white))

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
+ + + + +
RuntimeException
+ + +

See also

+ + - + EffectsInterface::brightness + + + +
RuntimeException -
+ +
+
+ +
+
+

+
at line 160
+ $this + convolve(Matrix $matrix) + +

+
+ + + +
+

Convolves the image.

+
+

Parameters

+ + + + + + + +
Matrix$matrixThe matrix from which derive the convolution kernel
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + +
RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::convolve +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gmagick/Font.html b/docs/API/API/Imagine/Gmagick/Font.html index ebd08ace9..778df5876 100644 --- a/docs/API/API/Imagine/Gmagick/Font.html +++ b/docs/API/API/Imagine/Gmagick/Font.html @@ -1,135 +1,249 @@ - - - - Imagine\Gmagick\Font | - - - -
- - -
- -
Class
-

Imagine\Gmagick\Font

+ + + + Imagine\Gmagick\Font | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Font extends AbstractFont

-
-

Font implementation using the Gmagick PHP extension

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gmagick
  5. \
  6. Font
    7. +
+
+
+ +
+

+ Font + +

+
+ +

class + Font extends AbstractFont +

+ + + +
+

Font implementation using the Gmagick PHP extension.

-

Methods

+ +

Properties

- +
- - - + + + - - - + + + - - - + + + - -
- - - __construct(Gmagick $gmagick, string $file, integer $size, ColorInterface $color) -

-

+ 		+ protected string $filefrom AbstractFont
- string + + protected int - getFile() -

Gets the fontfile for current font

- 		from AbstractFont$sizefrom AbstractFont
- integer + + protected ColorInterface - getSize() -

Gets font's integer point size

- 		from AbstractFont$colorfrom AbstractFont
+
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(Gmagick $gmagick, string $file, int $size, ColorInterface $color) + +

No description

+
+
+
+
+
+ string +
+
+ getFile() + +

Gets the fontfile for current font.

+
from AbstractFont
+
+
+
+ int +
+
+ getSize() + +

Gets font's integer point size.

+
from AbstractFont
+
+
+
ColorInterface - - +
+
getColor() -

Gets font's color

- - from AbstractFont - - - + +

Gets font's color.

+
from AbstractFont
+
+
+
+ string +
+
+ wrapText(string $string, int $maxWidth, int $angle = 0) + +

Split a string into multiple lines so that it fits a specific width.

+
from AbstractFont
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractFont
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractFont
+
+
+
BoxInterface - - - box(string $string, integer $angle) -

Gets BoxInterface of font size on the image based on string and angle

- - - - +
+
+ box(string $string, int $angle = 0) + +

Gets BoxInterface of font size on the image based on string and angle.

+
+
+

Details

-

-
at line 34
- public - __construct(Gmagick $gmagick, string $file, integer $size, ColorInterface $color) +
+
+

+
at line 33
+ + __construct(Gmagick $gmagick, string $file, int $size, ColorInterface $color) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - + - + - + - + - +
GmagickGmagick $gmagick -
string $file -
integerint $size -
ColorInterface $color -
@@ -139,131 +253,349 @@

Parameters

-

-
in AbstractFont at line 55
- final public string - getFile() +

+
+

+
in AbstractFont at line 66
+ final string + getFile() +

-

Gets the fontfile for current font

-

-

-
+ + + +
+

Gets the fontfile for current font.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ FontInterface::getFile +
+
-

-
in AbstractFont at line 63
- final public integer - getSize() +

+
+

+
in AbstractFont at line 76
+ final int + getSize() +

-

Gets font's integer point size

-

-

-
+ + + +
+

Gets font's integer point size.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ FontInterface::getSize +
+
-

-
in AbstractFont at line 71
- final public ColorInterface - getColor() +

+
+

+
in AbstractFont at line 86
+ final ColorInterface + getColor() +

-

Gets font's color

-

-

-
+ + + +
+

Gets font's color.

+

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ FontInterface::getColor +
+
-

-
at line 44
- public BoxInterface - box(string $string, integer $angle) +

+
+

+
in AbstractFont at line 96
+ string + wrapText(string $string, int $maxWidth, int $angle = 0) +

-

Gets BoxInterface of font size on the image based on string and angle

-

-

-
+ + + +
+

Split a string into multiple lines so that it fits a specific width.

+

Parameters

- +
- + + + + + + - + + + +
string $string -The text to be wrapped
int$maxWidthThe maximum width of the text
integerint $angle
+ + +

Return Value

+ + + + + + +
string
+ + + +

See also

+ + + + + + +
+ FontInterface::wrapText +
+ +
+
+ +
+
+

+
in AbstractFont at line 135
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+
+ +

Return Value

+ + + + + + +
ClassFactoryInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+ +
+
+ +
+
+

+
in AbstractFont at line 149
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + ClassFactoryAwareInterface::setClassFactory + + + +
-
+ +
+
+ +
+
+

+
at line 45
+ BoxInterface + box(string $string, int $angle = 0) + +

+
+ + + +
+

Gets BoxInterface of font size on the image based on string and angle.

+
+

Parameters

+ + + + + + + + + + +
string$string
int$angle

Return Value

- +
- +
BoxInterface -
+

See also

+ + + + + + +
+ FontInterface::box +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gmagick/Image.html b/docs/API/API/Imagine/Gmagick/Image.html index e726c7eb4..84b55aac4 100644 --- a/docs/API/API/Imagine/Gmagick/Image.html +++ b/docs/API/API/Imagine/Gmagick/Image.html @@ -1,498 +1,825 @@ - - - - Imagine\Gmagick\Image | - - - -
- - -
- -
Class
-

Imagine\Gmagick\Image

+ + + + Imagine\Gmagick\Image | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Image extends AbstractImage

-
-

Image implementation using the Gmagick PHP extension

-

-

+
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gmagick
  5. \
  6. Image
    7. +
+
+ +
+

+ Image + +

+
+ +

class + Image extends AbstractImage +

+ + + +
+

Image implementation using the Gmagick PHP extension.

-

Methods

+ +

Properties

- +
- - - + + + - - -
- ManipulatorInterface + + protected MetadataBag - thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) -

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

- 		from AbstractImage$metadatafrom AbstractImage
- MetadataInterface - +
+ + +

Methods

+ +
+
+
+ ManipulatorInterface +
+
+ thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
from AbstractImage
+
+
+
+ int[] +
+
+ getAllThumbnailModes() + +

Get all the available thumbnail modes.

+
from AbstractImage
+
+
+
+ array +
+
+ updateSaveOptions(array $options) + +

Updates a given array of save options for backward compatibility with legacy names.

+
from AbstractImage
+
+
+
+ MetadataBag +
+
metadata() -

Returns the Image's meta data

- - from AbstractImage - - - + +

Returns the Image's meta data.

+
from AbstractImage
+
+
+
- - +
+
__clone() -

Assures the metadata instance will be cloned, too

- - from AbstractImage - - - + +

Clones all the resources associated to this instance.

+
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractImage
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractImage
+
+
+
- - - __construct(Gmagick $gmagick, PaletteInterface $palette, MetadataBag $metadata) -

Constructs a new Image instance

- - - - - +
+
+ __construct(Gmagick $gmagick, PaletteInterface $palette, MetadataBag $metadata) + +

Constructs a new Image instance.

+
+
+
+
- - +
+
__destruct() -

Destroys allocated gmagick resources

- - - - - - Gmagick - - + +

Destroys allocated gmagick resources.

+
+
+
+
+ Gmagick +
+
getGmagick() -

Returns gmagick instance

- - - - - + +

Returns gmagick instance.

+
+
+
+
ManipulatorInterface - - +
+
copy() -

Copies current source image into a new ImageInterface instance

- - - - - - ManipulatorInterface - - + +

Copies current source image into a new ImageInterface instance.

+
+
+
+
+ $this +
+
crop(PointInterface $start, BoxInterface $size) -

Crops a specified box out of the source image (modifies the source image) Returns cropped self

- - - - - - ManipulatorInterface - - + +

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+
+
+
+
+ $this +
+
flipHorizontally() -

Flips current image using horizontal axis

- - - - - - ManipulatorInterface - - + +

Flips current image using vertical axis.

+
+
+
+
+ $this +
+
flipVertically() -

Flips current image using vertical axis

- - - - - - ManipulatorInterface - - + +

Flips current image using horizontal axis.

+
+
+
+
+ $this +
+
strip() -

Remove all profiles and comments

- - - - - - ManipulatorInterface - - - paste(ImageInterface $image, PointInterface $start) -

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

- - - - - - ManipulatorInterface - - + +

Remove all profiles and comments.

+
+
+
+
+ $this +
+
+ paste(ImageInterface $image, PointInterface $start, int $alpha = 100) + +

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

+
+
+
+
+ $this +
+
resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) -

Resizes current image and returns self

- - - - - - ManipulatorInterface - - - rotate(integer $angle, ColorInterface $background = null) -

Rotates an image at the given angle.

- - - - - - ManipulatorInterface - - + +

Resizes current image and returns self.

+
+
+
+
+ $this +
+
+ rotate(int $angle, ColorInterface $background = null) + +

Rotates an image at the given angle.

+
+
+
+
+ $this +
+
save(string $path = null, array $options = array()) -

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

- - - - - - ManipulatorInterface - - + +

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

+
+
+
+
+ $this +
+
show(string $format, array $options = array()) -

Outputs the image content

- - - - - + +

Outputs the image content.

+
+
+
+
string - - +
+
get(string $format, array $options = array()) -

Returns the image content as a binary string

- - - - - + +

Returns the image content as a binary string.

+
+
+
+
string - - +
+
__toString() -

Returns the image content as a PNG binary string

- - - - - + +

Returns the image content as a PNG binary string.

+
+
+
+
DrawerInterface - - +
+
draw() -

Instantiates and returns a DrawerInterface instance for image drawing

- - - - - + +

Instantiates and returns a DrawerInterface instance for image drawing.

+
+
+
+
EffectsInterface - - +
+
effects() -

-

- - - - - + +

No description

+
+
+
+
+
BoxInterface - - +
+
getSize() -

Returns current image size

- - - - - - ManipulatorInterface - - + +

Returns current image size.

+
+
+
+
+ $this +
+
applyMask(ImageInterface $mask) -

Applies a given mask to current image's alpha channel

- - - - - + +

Applies a given mask to current image's alpha channel.

+
+
+
+
ImageInterface - - +
+
mask() -

Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified

- - - - - - ManipulatorInterface - - + +

Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.

+
+
+
+
+ $this +
+
fill(FillInterface $fill) -

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

- - - - - - array - - + +

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+
+
+
+
+ ColorInterface[] +
+
histogram() -

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances

- - - - - + +

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.

+
+
+
+
ColorInterface - - +
+
getColorAt(PointInterface $point) -

Returns color at specified positions of current image

- - - - - + +

Returns color at specified positions of current image.

+
+
+
+
ColorInterface - - - pixelToColor(GmagickPixel $pixel) -

Returns a color given a pixel, depending the Palette context

- - - - - +
+
+ pixelToColor(GmagickPixel $pixel) + +

Returns a color given a pixel, depending the Palette context.

+
+
+
+
LayersInterface - - +
+
layers() -

Returns the image layers when applicable.

- + +

Returns the image layers when applicable.

+
+
+
+
+ $this +
+
+ interlace(string $scheme) + +

Enables or disables interlacing.

+
+
+
+
+ $this +
+
+ usePalette(PaletteInterface $palette) + +

Set a palette for the image. Useful to change colorspace.

+
+
+
+
+ PaletteInterface +
+
+ palette() + +

Return the current color palette.

+
+
+
+
+ $this +
+
+ profile(ProfileInterface $profile) + +

Applies a color profile on the Image.

+
+
+
+ + +

Details

+ +
+
+

+
in AbstractImage at line 36
+ ManipulatorInterface + thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

+
+ + + +
+

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
+

Parameters

+ + + + + - - - + + + - - + + + + +
BoxInterface$size
- ImageInterface - - interlace(string $scheme) -

Enables or disables interlacing

- 		int|string$settingsOne or more of the ManipulatorInterface::THUMBNAIL_ flags (joined with |). It may be a string for backward compatibility with old constant values that were strings.
- ImageInterface - - usePalette(PaletteInterface $palette) -

Set a palette for the image.

- 		string$filterThe filter to use for resizing, one of ImageInterface::FILTER_*
+ + +

Return Value

+ + + + + + +
ManipulatorInterface
+ + +

Exceptions

+ + + + +
RuntimeException
+ + +

See also

+ + - - + +
- PaletteInterface - - palette() -

Return the current color palette

- 		+ ManipulatorInterface::thumbnail +
+ +
+
+ +
+
+

+
in AbstractImage at line 146
+ protected int[] + getAllThumbnailModes() + +

+
+ + + +
+

Get all the available thumbnail modes.

+
+ +

Return Value

+ + + + + + +
int[]
+ + + +
+
+ +
+
+

+
in AbstractImage at line 161
+ protected array + updateSaveOptions(array $options) + +

+
+ + + +
+

Updates a given array of save options for backward compatibility with legacy names.

+
+

Parameters

+ + - - + +
- ImageInterface - - profile(ProfileInterface $profile) -

Applies a color profile on the Image

- 		array$options
+ +

Return Value

-

Details

+ + + + + +
array
+ + + +
+
-

-
in AbstractImage at line 27
- public ManipulatorInterface - thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
in AbstractImage at line 176
+ MetadataBag + metadata() +

-

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

-

-

-
-

Parameters

+ + + +
+

Returns the Image's meta data.

+
+ +

Return Value

+ + + + + + +
MetadataBag
- + + +

See also

+ +
- - + ImageInterface::metadata + + +
BoxInterface$size -
+ +
+
+ +
+
+

+
at line 85
+ + __clone() + +

+
+ + + +
+

Clones all the resources associated to this instance.

+
+ + + +

See also

+ + - - - - - - - + AbstractImage::__clone + +
string$mode -
string$filterThe filter to use for resizing, one of ImageInterface::FILTER_*
+
+
+ +
+
+

+
in AbstractImage at line 196
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+

Return Value

- +
- - + +
ManipulatorInterface -ClassFactoryInterface
-

Exceptions

+ +

See also

- +
- + ClassFactoryAwareInterface::getClassFactory + +
RuntimeException -
-
-

-
in AbstractImage at line 103
- public MetadataInterface - metadata() +

+
+

+
in AbstractImage at line 210
+ $this + setClassFactory(ClassFactoryInterface $classFactory) +

-

Returns the Image's meta data

-

-

-
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+

Return Value

- +
- - + +
MetadataInterface -$this
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+
-

-
in AbstractImage at line 111
- public - __clone() +

+
+

+
at line 62
+ + __construct(Gmagick $gmagick, PaletteInterface $palette, MetadataBag $metadata) +

-

Assures the metadata instance will be cloned, too

-

-

-
- - -
-
+ -

-
at line 60
- public - __construct(Gmagick $gmagick, PaletteInterface $palette, MetadataBag $metadata) -

-
-

Constructs a new Image instance

-

-

-
+
+

Constructs a new Image instance.

+

Parameters

- +
- + - + - + - +
GmagickGmagick $gmagick -
PaletteInterface $palette -
MetadataBag $metadata -
@@ -502,40 +829,49 @@

Parameters

-

-
at line 71
- public - __destruct() +

+
+

+
at line 72
+ + __destruct() +

-

Destroys allocated gmagick resources

-

-

-
+ + + +
+

Destroys allocated gmagick resources.

+
-

-
at line 84
- public Gmagick - getGmagick() +

+
+

+
at line 100
+ Gmagick + getGmagick() +

-

Returns gmagick instance

-

-

-
+ + + +
+

Returns gmagick instance.

+

Return Value

- +
- - + +
Gmagick -Gmagick
@@ -544,513 +880,649 @@

Return Value

-

-
at line 92
- public ManipulatorInterface - copy() +

+
+

+
at line 110
+ ManipulatorInterface + copy() +

-

Copies current source image into a new ImageInterface instance

-

-

-
+ + + +
+

Copies current source image into a new ImageInterface instance.

+

Return Value

- +
- +
ManipulatorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::copy +
+
-

-
at line 100
- public ManipulatorInterface - crop(PointInterface $start, BoxInterface $size) +

+
+

+
at line 120
+ $this + crop(PointInterface $start, BoxInterface $size) +

-

Crops a specified box out of the source image (modifies the source image) Returns cropped self

-

-

-
+ + + +
+

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+

Parameters

- +
- + - +
PointInterface $start -
BoxInterface $size -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + +
OutOfBoundsException -OutOfBoundsException
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::crop +
+
-

-
at line 118
- public ManipulatorInterface - flipHorizontally() +

+
+

+
at line 140
+ $this + flipHorizontally() +

-

Flips current image using horizontal axis

-

-

-
+ + + +
+

Flips current image using vertical axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::flipHorizontally +
+
-

-
at line 132
- public ManipulatorInterface - flipVertically() +

+
+

+
at line 156
+ $this + flipVertically() +

-

Flips current image using vertical axis

-

-

-
+ + + +
+

Flips current image using horizontal axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::flipVertically +
+
-

-
at line 146
- public ManipulatorInterface - strip() +

+
+

+
at line 172
+ $this + strip() +

-

Remove all profiles and comments

-

-

-
+ + + +
+

Remove all profiles and comments.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::strip +
+
-

-
at line 161
- public ManipulatorInterface - paste(ImageInterface $image, PointInterface $start) +

+
+

+
at line 194
+ $this + paste(ImageInterface $image, PointInterface $start, int $alpha = 100) +

-

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

-

Returns source image

-
+ + + +
+

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

Returns source image

+

Parameters

- +
- + - + + + + + +
ImageInterface $image -
PointInterface $start -
int$alphaHow to paste the image, from 0 (fully transparent) to 100 (fully opaque)

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + + +
InvalidArgumentException -InvalidArgumentException
OutOfBoundsException -RuntimeException
+ + +

See also

+ + - + ManipulatorInterface::paste + +
RuntimeException -
-
-

-
at line 183
- public ManipulatorInterface - resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
at line 223
+ $this + resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Resizes current image and returns self

-

-

-
+ + + +
+

Resizes current image and returns self.

+

Parameters

- +
- + - +
BoxInterface $size -
string $filter -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::resize +
+
-

-
at line 220
- public ManipulatorInterface - rotate(integer $angle, ColorInterface $background = null) +

+
+

+
at line 262
+ $this + rotate(int $angle, ColorInterface $background = null) +

-

Rotates an image at the given angle.

-

Optional $background can be used to specify the fill color of the empty -area of rotated image.

-
+ + + +
+

Rotates an image at the given angle.

Optional $background can be used to specify the fill color of the empty +area of rotated image.

+

Parameters

- +
- + - + - +
integerint $angle -
ColorInterface $background -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::rotate +
+
-

-
at line 305
- public ManipulatorInterface - save(string $path = null, array $options = array()) +

+
+

+
at line 377
+ $this + save(string $path = null, array $options = array()) +

-

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

-

-

-
+ + + +
+

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

Please remark that bmp is supported by the GD driver only since PHP 7.2.

+

Parameters

- +
- + - +
string $path -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::save +
+
-

-
at line 327
- public ManipulatorInterface - show(string $format, array $options = array()) +

+
+

+
at line 401
+ $this + show(string $format, array $options = array()) +

-

Outputs the image content

-

-

-
+ + + +
+

Outputs the image content.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::show +
+
-

-
at line 338
- public string - get(string $format, array $options = array()) +

+
+

+
at line 414
+ string + get(string $format, array $options = array()) +

-

Returns the image content as a binary string

-

-

-
+ + + +
+

Returns the image content as a binary string.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
@@ -1060,32 +1532,47 @@

Return Value

Exceptions

-
string binary
+
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::get +
+
-

-
at line 382
- public string - __toString() +

+
+

+
at line 459
+ string + __toString() +

-

Returns the image content as a PNG binary string

-

-

-
+ + + +
+

Returns the image content as a PNG binary string.

+

Return Value

- +
@@ -1095,307 +1582,437 @@

Return Value

Exceptions

-
string binary
+
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::__toString +
+
-

-
at line 390
- public DrawerInterface - draw() +

+
+

+
at line 469
+ DrawerInterface + draw() +

-

Instantiates and returns a DrawerInterface instance for image drawing

-

-

-
+ + + +
+

Instantiates and returns a DrawerInterface instance for image drawing.

+

Return Value

- +
- +
DrawerInterface -
+

See also

+ + + + + + +
+ ImageInterface::draw +
+
-

-
at line 398
- public EffectsInterface - effects() +

+
+

+
at line 479
+ EffectsInterface + effects() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
EffectsInterface -
+

See also

+ + + + + + +
+ ImageInterface::effects +
+
-

-
at line 406
- public BoxInterface - getSize() +

+
+

+
at line 489
+ BoxInterface + getSize() +

-

Returns current image size

-

-

-
+ + + +
+

Returns current image size.

+

Return Value

- +
- +
BoxInterface -
+

See also

+ + + + + + +
+ ImageInterface::getSize +
+
-

-
at line 421
- public ManipulatorInterface - applyMask(ImageInterface $mask) +

+
+

+
at line 509
+ $this + applyMask(ImageInterface $mask) +

-

Applies a given mask to current image's alpha channel

-

-

-
+ + + +
+

Applies a given mask to current image's alpha channel.

+

Parameters

- +
- +
ImageInterface $mask -

Return Value

- +
- - + +
ManipulatorInterface -$this
+

See also

+ + + + + + +
+ ManipulatorInterface::applyMask +
+
-

-
at line 447
- public ImageInterface - mask() +

+
+

+
at line 537
+ ImageInterface + mask() +

-

Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified

-

-

-
+ + + +
+

Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.

+

Return Value

- +
- +
ImageInterface -
+

See also

+ + + + + + +
+ ImageInterface::mask +
+
-

-
at line 463
- public ManipulatorInterface - fill(FillInterface $fill) +

+
+

+
at line 555
+ $this + fill(FillInterface $fill) +

-

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

-

-

-
+ + + +
+

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+

Parameters

- +
- +
FillInterface $fill -

Return Value

- +
- - + +
ManipulatorInterface -$this
+

See also

+ + + + + + +
+ ManipulatorInterface::fill +
+
-

-
at line 496
- public array - histogram() +

+
+

+
at line 590
+ ColorInterface[] + histogram() +

-

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances

-

-

-
+ + + +
+

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.

+

Return Value

- +
- - + +
array -ColorInterface[]
+

See also

+ + + + + + +
+ ImageInterface::histogram +
+
-

-
at line 514
- public ColorInterface - getColorAt(PointInterface $point) +

+
+

+
at line 610
+ ColorInterface + getColorAt(PointInterface $point) +

-

Returns color at specified positions of current image

-

-

-
+ + + +
+

Returns color at specified positions of current image.

+

Parameters

- +
- +
PointInterface $point -

Return Value

- +
- +
ColorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::getColorAt +
+
-

-
at line 547
- public ColorInterface - pixelToColor(GmagickPixel $pixel) +

+
+

+
at line 644
+ ColorInterface + pixelToColor(GmagickPixel $pixel) +

-

Returns a color given a pixel, depending the Palette context

-

Note : this method is public for PHP 5.3 compatibility

-
+ + + +
+

Returns a color given a pixel, depending the Palette context.

Note : this method is public for PHP 5.3 compatibility

+

Parameters

- +
- + - +
GmagickPixelGmagickPixel $pixel -

Return Value

- +
- +
ColorInterface -

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException In case a unknown color is requested
@@ -1404,214 +2021,292 @@

Exceptions

-

-
at line 589
- public LayersInterface - layers() +

+
+

+
at line 690
+ LayersInterface + layers() +

-

Returns the image layers when applicable.

-

-

-
+ + + +
+

Returns the image layers when applicable.

+

Return Value

- +
- +
LayersInterface -

Exceptions

- +
- + - +
RuntimeExceptionRuntimeException In case the layer can not be returned
OutOfBoundsExceptionOutOfBoundsException In case the index is not a valid value
+

See also

+ + + + + + +
+ ImageInterface::layers +
+
-

-
at line 597
- public ImageInterface - interlace(string $scheme) +

+
+

+
at line 704
+ $this + interlace(string $scheme) +

-

Enables or disables interlacing

-

-

-
+ + + +
+

Enables or disables interlacing.

+

Parameters

- +
- +
string $scheme -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException When an unsupported Interface type is supplied
+

See also

+ + + + + + +
+ ImageInterface::interlace +
+
-

-
at line 618
- public ImageInterface - usePalette(PaletteInterface $palette) +

+
+

+
at line 727
+ $this + usePalette(PaletteInterface $palette) +

-

Set a palette for the image.

-

Useful to change colorspace.

-
+ + + +
+

Set a palette for the image. Useful to change colorspace.

+

Parameters

- +
- +
PaletteInterface $palette -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::usePalette +
+
-

-
at line 653
- public PaletteInterface - palette() +

+
+

+
at line 764
+ PaletteInterface + palette() +

-

Return the current color palette

-

-

-
+ + + +
+

Return the current color palette.

+

Return Value

- +
- +
PaletteInterface -
+

See also

+ + + + + + +
+ ImageInterface::palette +
+
-

-
at line 661
- public ImageInterface - profile(ProfileInterface $profile) +

+
+

+
at line 774
+ $this + profile(ProfileInterface $profile) +

-

Applies a color profile on the Image

-

-

-
+ + + +
+

Applies a color profile on the Image.

+

Parameters

- +
- +
ProfileInterface $profile -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::profile +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gmagick/Imagine.html b/docs/API/API/Imagine/Gmagick/Imagine.html index 2b177036b..b4f2ae6fa 100644 --- a/docs/API/API/Imagine/Gmagick/Imagine.html +++ b/docs/API/API/Imagine/Gmagick/Imagine.html @@ -1,215 +1,471 @@ - - - - Imagine\Gmagick\Imagine | - - - -
- - -
- -
Class
-

Imagine\Gmagick\Imagine

+ + + + Imagine\Gmagick\Imagine | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Imagine extends AbstractImagine

-
-

Imagine implementation using the Gmagick PHP extension

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gmagick
  5. \
  6. Imagine
    7. +
+
+
+ +
+

+ Imagine + +

+
+ +

class + Imagine extends AbstractImagine +

+ + + + +
+

Imagine implementation using the Gmagick PHP extension.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +

Loads an image from a resource $resource.

+
+ +
+
+ FontInterface +
+
+ font(string $file, int $size, ColorInterface $color) + +

Constructs a font with specified $file, $size and $color.

+
+
+ + + +

Details

+ +
+
+

+
in AbstractImagine at line 36
+ $this + setMetadataReader(MetadataReaderInterface $metadataReader) + +

+
+ + + +
+

Set the object to be used to read image metadata.

+
+

Parameters

+ +
- ImagineInterface - +
+
+
+ $this +
+
setMetadataReader(MetadataReaderInterface $metadataReader) -

-

-
from AbstractImagine
+ +

Set the object to be used to read image metadata.

+
from AbstractImagine
+ +
+
MetadataReaderInterface -
+ +
getMetadataReader() -

-

-
from AbstractImagine
+ +

Get the object to be used to read image metadata.

+
from AbstractImagine
+ +
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractImagine
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractImagine
+
+
+
+ string +
+
+ checkPath(string|object $path) + +

Checks a path that could be used with ImagineInterface::open and returns +a proper string.

+
from AbstractImagine
+
+
+
-
+ +
__construct() -

-

-
+ +

No description

+ +
+ +
+
ImageInterface -
- open(string $path) -

Opens an existing image from $path

-
+ +
+ open(string|LoaderInterface|mixed $path) + +

Opens an existing image from $path.

+
+ +
+
ImageInterface -
+ +
create(BoxInterface $size, ColorInterface $color = null) -

Creates a new empty image with an optional background color

-
+ +

Creates a new empty image with an optional background color.

+
+ +
+
ImageInterface -
+ +
load(string $string) -

Loads an image from a binary $string

-
+ +

Loads an image from a binary $string.

+
+ +
+
ImageInterface -
+ +
read(resource $resource) -

Loads an image from a resource $resource

-
+ + + +
MetadataReaderInterface$metadataReader
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + - - +
- FontInterface - - font(string $file, integer $size, ColorInterface $color) -

Constructs a font with specified $file, $size and $color

- 		+ ImagineInterface::setMetadataReader +
+
+
-

Details

+
+
+

+
in AbstractImagine at line 48
+ MetadataReaderInterface + getMetadataReader() + +

+
+ + -

-
in AbstractImagine at line 27
- public ImagineInterface - setMetadataReader(MetadataReaderInterface $metadataReader) +
+

Get the object to be used to read image metadata.

+
+ +

Return Value

+ + + + + + +
MetadataReaderInterface
+ + + +

See also

+ + + + + + +
+ ImagineInterface::getMetadataReader +
+ +
+

+ +
+
+

+
in AbstractImagine at line 62
+ $this + setClassFactory(ClassFactoryInterface $classFactory) +

-

-

-

-

-
+ + + +
+

Set the class factory instance to be used.

+

Parameters

- +
+ + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + - - + ClassFactoryAwareInterface::setClassFactory + +
MetadataReaderInterface$metadataReader -
+
+
+ +
+
+

+
in AbstractImagine at line 74
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+

Return Value

- +
- - + +
ImagineInterface -ClassFactoryInterface
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+
-

-
in AbstractImagine at line 37
- public MetadataReaderInterface - getMetadataReader() +

+
+

+
in AbstractImagine at line 93
+ protected string + checkPath(string|object $path) +

-

-

-

-

-
+ + + +
+

Checks a path that could be used with ImagineInterface::open and returns +a proper string.

+
+

Parameters

+ + + + + + + +
string|object$path
+

Return Value

- +
- - + +
MetadataReaderInterface -string
+

Exceptions

+ + + + + + +
InvalidArgumentExceptionin case the given path is invalid
+
-

-
at line 34
- public - __construct() +

+
+

+
at line 36
+ + __construct() +

-

-

-

-

-
+ + + +

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -217,257 +473,327 @@

Exceptions

-

-
at line 44
- public ImageInterface - open(string $path) +

+
+

+
at line 48
+ ImageInterface + open(string|LoaderInterface|mixed $path) +

-

Opens an existing image from $path

-

-

-
+ + + +
+

Opens an existing image from $path.

+

Parameters

- +
- + - +
stringstring|LoaderInterface|mixed $path -the file path, a LoaderInterface instance, or an object whose string representation is the image path

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::open +
+
-

-
at line 61
- public ImageInterface - create(BoxInterface $size, ColorInterface $color = null) +

+
+

+
at line 72
+ ImageInterface + create(BoxInterface $size, ColorInterface $color = null) +

-

Creates a new empty image with an optional background color

-

-

-
+ + + +
+

Creates a new empty image with an optional background color.

+

Parameters

- +
- + - +
BoxInterface $size -
ColorInterface $color -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + + - - + +
InvalidArgumentException -InvalidArgumentException
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::create +
+
-

-
at line 105
- public ImageInterface - load(string $string) +

+
+

+
at line 118
+ ImageInterface + load(string $string) +

-

Loads an image from a binary $string

-

-

-
+ + + +
+

Loads an image from a binary $string.

+

Parameters

- +
- +
string $string -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::load +
+
-

-
at line 113
- public ImageInterface - read(resource $resource) +

+
+

+
at line 128
+ ImageInterface + read(resource $resource) +

-

Loads an image from a resource $resource

-

-

-
+ + + +
+

Loads an image from a resource $resource.

+

Parameters

- +
- +
resource $resource -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::read +
+
-

-
at line 131
- public FontInterface - font(string $file, integer $size, ColorInterface $color) +

+
+

+
at line 148
+ FontInterface + font(string $file, int $size, ColorInterface $color) +

-

Constructs a font with specified $file, $size and $color

-

The font size is to be specified in points (e.g. 10pt means 10)

-
+ + + +
+

Constructs a font with specified $file, $size and $color.

The font size is to be specified in points (e.g. 10pt means 10)

+

Parameters

- +
- + - + - + - +
string $file -
integerint $size -
ColorInterface $color -

Return Value

- +
- +
FontInterface -
+

See also

+ + + + + + +
+ ImagineInterface::font +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gmagick/Layers.html b/docs/API/API/Imagine/Gmagick/Layers.html index 6b0695284..282c608ea 100644 --- a/docs/API/API/Imagine/Gmagick/Layers.html +++ b/docs/API/API/Imagine/Gmagick/Layers.html @@ -1,515 +1,753 @@ - - - - Imagine\Gmagick\Layers | - - - -
- - -
- -
Class
-

Imagine\Gmagick\Layers

+ + + + Imagine\Gmagick\Layers | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Layers extends AbstractLayers

+
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Gmagick
  5. \
  6. Layers
    7. +
+
+
+ +
+

+ Layers + +

+
+ +

class + Layers extends AbstractLayers +

+ + + + +

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- LayersInterface - +
+
+
+ $this +
+
add(ImageInterface $image) -

Adds an image at the end of the layers stack

-
from AbstractLayers
- LayersInterface - - set(integer $offset, ImageInterface $image) -

Set an image at offset

- 		from AbstractLayers
- LayersInterface - - remove(integer $offset) -

Removes the image at offset

- 		from AbstractLayers
+ +

Adds an image at the end of the layers stack.

+
from AbstractLayers
+ +
+
+ $this +
+
+ set(int $offset, ImageInterface $image) + +

Set an image at offset.

+
from AbstractLayers
+
+
+
+ $this +
+
+ remove(int $offset) + +

Removes the image at offset.

+
from AbstractLayers
+
+
+
ImageInterface -
- get(integer $offset) -

Returns the image at offset

- 		from AbstractLayers
- Boolean - - has(integer $offset) -

Returns true if a layer at offset is preset

- 		from AbstractLayers
+ +
+ get(int $offset) + +

Returns the image at offset.

+
from AbstractLayers
+ +
+
+ bool +
+
+ has(int $offset) + +

Returns true if a layer at offset is preset.

+
from AbstractLayers
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractLayers
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractLayers
+
+
+
-
- __construct(Image $image, PaletteInterface $palette, Gmagick $resource) -

-

-
+ +
+ __construct(Image $image, PaletteInterface $palette, Gmagick $resource, int $initialOffset = 0) + +

No description

+
+
+ +
+
-
+ +
merge() -

Merge layers into the original objects

-
- - + +

Merge layers into the original objects.

+
+ +
+
+ $this +
+
coalesce() -

Coalesce layers.

-
- LayersInterface - - animate(string $format, integer $delay, integer $loops) -

Animates layers

-
+ +

Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.

+
+ +
+
+ $this +
+
+ animate(string $format, int $delay, int $loops) + +

Animates layers.

+
+
+
+
-
+ +
current() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
key() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
next() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
rewind() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
valid() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
count() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetExists($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetGet($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetSet($offset, $image) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetUnset($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+
+

Details

-

-
in AbstractLayers at line 19
- public LayersInterface - add(ImageInterface $image) +
+
+

+
in AbstractLayers at line 30
+ $this + add(ImageInterface $image) +

-

Adds an image at the end of the layers stack

-

-

-
+ + + +
+

Adds an image at the end of the layers stack.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ LayersInterface::add +
+
-

-
in AbstractLayers at line 29
- public LayersInterface - set(integer $offset, ImageInterface $image) +

+
+

+
in AbstractLayers at line 42
+ $this + set(int $offset, ImageInterface $image) +

-

Set an image at offset

-

-

-
+ + + +
+

Set an image at offset.

+

Parameters

- +
- + - + - +
integerint $offset -
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
OutOfBoundsException -OutOfBoundsException
+

See also

+ + + + + + +
+ LayersInterface::set +
+
-

-
in AbstractLayers at line 39
- public LayersInterface - remove(integer $offset) +

+
+

+
in AbstractLayers at line 54
+ $this + remove(int $offset) +

-

Removes the image at offset

-

-

-
+ + + +
+

Removes the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
+

See also

+ + + + + + +
+ LayersInterface::remove +
+
-

-
in AbstractLayers at line 49
- public ImageInterface - get(integer $offset) +

+
+

+
in AbstractLayers at line 66
+ ImageInterface + get(int $offset) +

-

Returns the image at offset

-

-

-
+ + + +
+

Returns the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
+

See also

+ + + + + + +
+ LayersInterface::get +
+
-

-
in AbstractLayers at line 57
- public Boolean - has(integer $offset) +

+
+

+
in AbstractLayers at line 76
+ bool + has(int $offset) +

-

Returns true if a layer at offset is preset

-

-

-
+ + + +
+

Returns true if a layer at offset is preset.

+

Parameters

- +
- + + + +
integerint $offset
+ + +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + LayersInterface::has + + + +
-
+ +
+
+ +
+
+

+
in AbstractLayers at line 86
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + +
ClassFactoryInterface$classFactory

Return Value

- +
- - + +
Boolean -$this
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+
-

-
at line 49
- public - __construct(Image $image, PaletteInterface $palette, Gmagick $resource) +

+
+

+
in AbstractLayers at line 98
+ ClassFactoryInterface + getClassFactory() +

-

-

-

-

-
+ + + +
+

Get the class factory instance to be used.

+
+ +

Return Value

+ + + + + + +
ClassFactoryInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+ +
+
+ +
+
+

+
at line 56
+ + __construct(Image $image, PaletteInterface $palette, Gmagick $resource, int $initialOffset = 0) + +

+
+ + + +

Parameters

- +
- + - + - + - + + + + + +
Image $image -
PaletteInterface $palette -
GmagickGmagick $resource -
int$initialOffset
@@ -519,73 +757,128 @@

Parameters

-

-
at line 59
- public - merge() +

+
+

+
at line 69
+ + merge() +

-

Merge layers into the original objects

-

-

-
+ + + +
+

Merge layers into the original objects.

+

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ LayersInterface::merge +
+
-

-
at line 74
- public - coalesce() +

+
+

+
at line 86
+ $this + coalesce() +

-

Coalesce layers.

-

Each layer in the sequence is the same size as the first and composited with the next layer in -the sequence.

-
+ + +
+

Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.

+
+

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
NotSupportedException
+ +

See also

+ + + + + + +
+ LayersInterface::coalesce +
+
-

-
at line 82
- public LayersInterface - animate(string $format, integer $delay, integer $loops) +

+
+

+
at line 96
+ $this + animate(string $format, int $delay, int $loops) +

-

Animates layers

-

-

-
+ + + +
+

Animates layers.

+

Parameters

- +
- + - + @@ -594,246 +887,418 @@

Parameters

Return Value

-
string $format The output output format
integerint $delay The delay in milliseconds between two frames
integerint $loops The number of loops, 0 means infinite
+
- - + +
LayersInterface -$this

Exceptions

- +
- + - +
InvalidArgumentExceptionInvalidArgumentException In case an invalid argument is provided
RuntimeExceptionRuntimeException In case the driver fails to animate
+

See also

+ + + + + + +
+ LayersInterface::animate +
+
-

-
at line 117
- public - current() +

+
+

+
at line 133
+ + current() +

-

{@inheritdoc}

-

-

-
+ + +
+

{@inheritdoc}

+
+ +

See also

+ + + + + + +
+ \Iterator::current() +
+
-

-
at line 146
- public - key() +

+
+

+
at line 166
+ + key() +

-

{@inheritdoc}

-

-

-
+ + +
+

{@inheritdoc}

+
+ +

See also

+ + + + + + +
+ \Iterator::key() +
+
-

-
at line 154
- public - next() +

+
+

+
at line 176
+ + next() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Iterator::next() +
+
-

-
at line 162
- public - rewind() +

+
+

+
at line 186
+ + rewind() +

-

{@inheritdoc}

-

-

-
+ + +
+

{@inheritdoc}

+
+ +

See also

+ + + + + + +
+ \Iterator::rewind() +
+
-

-
at line 170
- public - valid() +

+
+

+
at line 196
+ + valid() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Iterator::valid() +
+
-

-
at line 178
- public - count() +

+
+

+
at line 206
+ + count() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Countable::count() +
+
-

-
at line 190
- public - offsetExists($offset) +

+
+

+
at line 220
+ + offsetExists($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetExists() +
+
-

-
at line 198
- public - offsetGet($offset) +

+
+

+
at line 230
+ + offsetGet($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetGet() +
+
-

-
at line 206
- public - offsetSet($offset, $image) +

+
+

+
at line 240
+ + offsetSet($offset, $image) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- + - +
$offset -
$image -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetSet() +
+
-

-
at line 257
- public - offsetUnset($offset) +

+
+

+
at line 293
+ + offsetUnset($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetUnset() +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Gmagick/namespace-frame.html b/docs/API/API/Imagine/Gmagick/namespace-frame.html deleted file mode 100644 index d81362780..000000000 --- a/docs/API/API/Imagine/Gmagick/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Gmagick | - - - diff --git a/docs/API/API/Imagine/Image.html b/docs/API/API/Imagine/Image.html index 76dbce59f..b9aa128a5 100644 --- a/docs/API/API/Imagine/Image.html +++ b/docs/API/API/Imagine/Image.html @@ -1,103 +1,246 @@ - - - - Imagine\Image | - - - -
- + + + + Imagine\Image | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
-
Namespace
-

Imagine\Image

+
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
    6. +
+
+
+ +
+

Imagine\Image

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AbstractFontAbstract font base class
AbstractImage -
AbstractImagine -
AbstractLayers -
BoxA box implementation
PointThe point class
Profile -
+ +

Namespaces

+
+ Imagine\Image\FillImagine\Image\HistogramImagine\Image\MetadataImagine\Image\PaletteImagine\Image\Point
+ +

Classes

+ +
+
+
+ AbstractFont + +
+
+ Abstract font base class. +
+
+
+
+ AbstractImage + +
+
+ +
+
+
+
+ AbstractImagine + +
+
+ +
+
+
+
+ AbstractLayers + +
+
+ +
+
+
+
+ Box + +
+
+ A box implementation. +
+
+
+
+ Point + +
+
+ The point class. +
+
+
+
+ PointSigned + +
+
+ A point class that allows negative values of coordinates. +
+
+
+
+ Profile + +
+
+ The default implementation of ProfileInterface. +
+
+

Interfaces

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BoxInterfaceInterface for a box
FontInterfaceThe font interface
ImageInterfaceThe image interface
ImagineInterfaceThe imagine interface
LayersInterfaceThe layers interface
ManipulatorInterfaceThe manipulator interface
PointInterfaceThe point interface
ProfileInterface -
+ +
+
+
+ BoxInterface + +
+
+ Interface for a box. +
+
+
+
+ FontInterface + +
+
+ The font interface. +
+
+
+
+ ImageInterface + +
+
+ The image interface. +
+
+
+
+ ImagineInterface + +
+
+ The imagine interface. +
+
+
+
+ LayersInterface + +
+
+ The layers interface. +
+
+
+
+ ManipulatorInterface + +
+
+ The manipulator interface. +
+
+
+
+ PointInterface + +
+
+ The point interface. +
+
+
+
+ ProfileInterface + +
+
+ +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/AbstractFont.html b/docs/API/API/Imagine/Image/AbstractFont.html index 576fc89a1..d0a6d64bb 100644 --- a/docs/API/API/Imagine/Image/AbstractFont.html +++ b/docs/API/API/Imagine/Image/AbstractFont.html @@ -1,117 +1,236 @@ - - - - Imagine\Image\AbstractFont | - - - -
- - -
- -
Class
-

Imagine\Image\AbstractFont

+ + + + Imagine\Image\AbstractFont | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. AbstractFont
    7. +
+
+
+ +
+

+ AbstractFont + +

-
-

abstract class + +

abstract class AbstractFont implements - FontInterface

+ FontInterface, ClassFactoryAwareInterface +

+ + +
-

Abstract font base class

-

-

-
+

Abstract font base class.

-

Methods

+

Properties

- +
- - + + - - + + - - + + - -
- - - __construct(string $file, integer $size, ColorInterface $color) -

Constructs a font with specified $file, $size and $color

+ 		+ protected string $file
- string - - getFile() -

Gets the fontfile for current font

+ 		+ protected int $size
- integer - - getSize() -

Gets font's integer point size

+ 		+ protected ColorInterface $color
+
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(string $file, int $size, ColorInterface $color) + +

Constructs a font with specified $file, $size and $color.

+
+
+
+
+ string +
+
+ getFile() + +

Gets the fontfile for current font.

+
+
+
+
+ int +
+
+ getSize() + +

Gets font's integer point size.

+
+
+
+
ColorInterface - - +
+
getColor() -

Gets font's color

- - - - + +

Gets font's color.

+
+
+
+
+ string +
+
+ wrapText(string $string, int $maxWidth, int $angle = 0) + +

Split a string into multiple lines so that it fits a specific width.

+
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
+
+

Details

-

-
at line 45
- public - __construct(string $file, integer $size, ColorInterface $color) +
+
+

+
at line 54
+ + __construct(string $file, int $size, ColorInterface $color) +

-

Constructs a font with specified $file, $size and $color

-

The font size is to be specified in points (e.g. 10pt means 10)

-
+ + + +
+

Constructs a font with specified $file, $size and $color.

The font size is to be specified in points (e.g. 10pt means 10)

+

Parameters

- +
- + - + - + - +
string $file -
integerint $size -
ColorInterface $color -
@@ -121,88 +240,293 @@

Parameters

-

-
at line 55
- final public string - getFile() +

+
+

+
at line 66
+ final string + getFile() +

-

Gets the fontfile for current font

-

-

-
+ + + +
+

Gets the fontfile for current font.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ FontInterface::getFile +
+
-

-
at line 63
- final public integer - getSize() +

+
+

+
at line 76
+ final int + getSize() +

-

Gets font's integer point size

-

-

-
+ + + +
+

Gets font's integer point size.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ FontInterface::getSize +
+
-

-
at line 71
- final public ColorInterface - getColor() +

+
+

+
at line 86
+ final ColorInterface + getColor() +

-

Gets font's color

-

-

-
+ + + +
+

Gets font's color.

+

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ FontInterface::getColor +
+
+
+
+

+
at line 96
+ string + wrapText(string $string, int $maxWidth, int $angle = 0) + +

+
+ + + +
+

Split a string into multiple lines so that it fits a specific width.

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
string$stringThe text to be wrapped
int$maxWidthThe maximum width of the text
int$angle
+ + +

Return Value

+ + + + + + +
string
+ + + +

See also

+ + + + + + +
+ FontInterface::wrapText +
+ +
+
+ +
+
+

+
at line 135
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+
+ +

Return Value

+ + + + + + +
ClassFactoryInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+ +
+
+ +
+
+

+
at line 149
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+ +
+
+ +
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/AbstractImage.html b/docs/API/API/Imagine/Image/AbstractImage.html index 88ec5758c..106c62a3a 100644 --- a/docs/API/API/Imagine/Image/AbstractImage.html +++ b/docs/API/API/Imagine/Image/AbstractImage.html @@ -1,97 +1,215 @@ - - - - Imagine\Image\AbstractImage | - - - -
- - -
- -
Class
-

Imagine\Image\AbstractImage

+ + + + Imagine\Image\AbstractImage | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. AbstractImage
    7. +
+
+
+ +
+

+ AbstractImage + +

-
-

abstract class + +

abstract class AbstractImage implements - ImageInterface

+ ImageInterface, ClassFactoryAwareInterface +

+ + -

Methods

+ +

Properties

- +
- - + + - - -
- ManipulatorInterface - - thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) -

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

+ 		+ protected MetadataBag $metadata
- MetadataInterface - +
+ + +

Methods

+ +
+
+
+ ManipulatorInterface +
+
+ thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
+
+
+
+ int[] +
+
+ getAllThumbnailModes() + +

Get all the available thumbnail modes.

+
+
+
+
+ array +
+
+ updateSaveOptions(array $options) + +

Updates a given array of save options for backward compatibility with legacy names.

+
+
+
+
+ MetadataBag +
+
metadata() -

Returns the Image's meta data

- - - - - + +

Returns the Image's meta data.

+
+
+
+
- - +
+
__clone() -

Assures the metadata instance will be cloned, too

- - - - + +

Clones all the resources associated to this instance.

+
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
+
+

Details

-

-
at line 27
- public ManipulatorInterface - thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +
+
+

+
at line 36
+ ManipulatorInterface + thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

-

-

-
+ + + +
+

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+

Parameters

- +
- + - - - + + + @@ -103,47 +221,100 @@

Parameters

Return Value

-
BoxInterface $size -
string$mode -int|string$settingsOne or more of the ManipulatorInterface::THUMBNAIL_ flags (joined with |). It may be a string for backward compatibility with old constant values that were strings.
string
+
- +
ManipulatorInterface -

Exceptions

- +
+ + + + +
RuntimeException
+ + +

See also

+ + - + ManipulatorInterface::thumbnail + +
RuntimeException -
+
+
+ +
+
+

+
at line 146
+ protected int[] + getAllThumbnailModes() + +

+
+ + + +
+

Get all the available thumbnail modes.

+
+ +

Return Value

+ + + + + + +
int[]
+ +
-

-
at line 103
- public MetadataInterface - metadata() +

+
+

+
at line 161
+ protected array + updateSaveOptions(array $options) +

-

Returns the Image's meta data

-

-

-
+ + + +
+

Updates a given array of save options for backward compatibility with legacy names.

+
+

Parameters

+ + + + + + + +
array$options
+

Return Value

- +
- - + +
MetadataInterface -array
@@ -152,26 +323,171 @@

Return Value

-

-
at line 111
- public - __clone() +

+
+

+
at line 176
+ MetadataBag + metadata() +

-

Assures the metadata instance will be cloned, too

-

-

-
+ + + +
+

Returns the Image's meta data.

+
+ +

Return Value

+ + + + + + +
MetadataBag
+ + + +

See also

+ + + + + + +
+ ImageInterface::metadata +
+ +
+
+ +
+
+

+
at line 184
+ + __clone() + +

+
+ + + +
+

Clones all the resources associated to this instance.

+
+ + + +
+
+ +
+
+

+
at line 196
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+
+ +

Return Value

+ + + + + + +
ClassFactoryInterface
+ +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+ +
+
+ +
+
+

+
at line 210
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/AbstractImagine.html b/docs/API/API/Imagine/Image/AbstractImagine.html index e4c0da532..71479ca5e 100644 --- a/docs/API/API/Imagine/Image/AbstractImagine.html +++ b/docs/API/API/Imagine/Image/AbstractImagine.html @@ -1,134 +1,399 @@ - - - - Imagine\Image\AbstractImagine | - - - -
- - -
- -
Class
-

Imagine\Image\AbstractImagine

+ + + + Imagine\Image\AbstractImagine | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. AbstractImagine
    7. +
+
+
+ +
+

+ AbstractImagine + +

-
-

abstract class + +

abstract class AbstractImagine implements - ImagineInterface

+ ImagineInterface +

+ + + +

Methods

- - - - + +

Set the object to be used to read image metadata.

+
+ +
+
+ MetadataReaderInterface +
+
+ getMetadataReader() + +

Get the object to be used to read image metadata.

+
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
+
+
+
+ string +
+
+ checkPath(string|object $path) + +

Checks a path that could be used with ImagineInterface::open and returns +a proper string.

+
+
+ + + +

Details

+ +
+
+

+
at line 36
+ $this + setMetadataReader(MetadataReaderInterface $metadataReader) + +

+
+ + + +
+

Set the object to be used to read image metadata.

+
+

Parameters

+ +
- ImagineInterface - +
+
+
+ $this +
+
setMetadataReader(MetadataReaderInterface $metadataReader) -

-

-
+ + + +
MetadataReaderInterface$metadataReader
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + - - +
- MetadataReaderInterface - - getMetadataReader() -

-

- 		+ ImagineInterface::setMetadataReader +
+
+
-

Details

+
+
+

+
at line 48
+ MetadataReaderInterface + getMetadataReader() + +

+
+ + + +
+

Get the object to be used to read image metadata.

+
+ +

Return Value

+ + + + + + +
MetadataReaderInterface
+ + + +

See also

-

-
at line 27
- public ImagineInterface - setMetadataReader(MetadataReaderInterface $metadataReader) + + + + + +
+ ImagineInterface::getMetadataReader +
+ +

+
+ +
+
+

+
at line 62
+ $this + setClassFactory(ClassFactoryInterface $classFactory) +

-

-

-

-

-
+ + + +
+

Set the class factory instance to be used.

+

Parameters

- +
+ + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + - - + ClassFactoryAwareInterface::setClassFactory + +
MetadataReaderInterface$metadataReader -
+
+
+ +
+
+

+
at line 74
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+

Return Value

- +
- - + +
ImagineInterface -ClassFactoryInterface
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+
-

-
at line 37
- public MetadataReaderInterface - getMetadataReader() +

+
+

+
at line 93
+ protected string + checkPath(string|object $path) +

-

-

-

-

-
+ + + +
+

Checks a path that could be used with ImagineInterface::open and returns +a proper string.

+
+

Parameters

+ + + + + + + +
string|object$path
+

Return Value

- +
- - + +
MetadataReaderInterface -string
+

Exceptions

+ + + + + + +
InvalidArgumentExceptionin case the given path is invalid
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/AbstractLayers.html b/docs/API/API/Imagine/Image/AbstractLayers.html index 6fb996c7f..503bb8d75 100644 --- a/docs/API/API/Imagine/Image/AbstractLayers.html +++ b/docs/API/API/Imagine/Image/AbstractLayers.html @@ -1,348 +1,588 @@ - - - - Imagine\Image\AbstractLayers | - - - -
- - -
+ + + + Imagine\Image\AbstractLayers | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
-
Class
-

Imagine\Image\AbstractLayers

+
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. AbstractLayers
    7. +
+
+
+ +
+

+ AbstractLayers + +

-
-

abstract class + +

abstract class AbstractLayers implements - LayersInterface

+ LayersInterface, ClassFactoryAwareInterface +

+ + + +

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- LayersInterface - +
+
+
+ $this +
+
add(ImageInterface $image) -

Adds an image at the end of the layers stack

-
- LayersInterface - - set(integer $offset, ImageInterface $image) -

Set an image at offset

-
- LayersInterface - - remove(integer $offset) -

Removes the image at offset

-
+ +

Adds an image at the end of the layers stack.

+
+ +
+
+ $this +
+
+ set(int $offset, ImageInterface $image) + +

Set an image at offset.

+
+
+
+
+ $this +
+
+ remove(int $offset) + +

Removes the image at offset.

+
+
+
+
ImageInterface -
- get(integer $offset) -

Returns the image at offset

-
- Boolean - - has(integer $offset) -

Returns true if a layer at offset is preset

-
+
+
+ get(int $offset) + +

Returns the image at offset.

+
+
+
+
+ bool +
+
+ has(int $offset) + +

Returns true if a layer at offset is preset.

+
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
+
+

Details

-

-
at line 19
- public LayersInterface - add(ImageInterface $image) +
+
+

+
at line 30
+ $this + add(ImageInterface $image) +

-

Adds an image at the end of the layers stack

-

-

-
+ + + +
+

Adds an image at the end of the layers stack.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ LayersInterface::add +
+
-

-
at line 29
- public LayersInterface - set(integer $offset, ImageInterface $image) +

+
+

+
at line 42
+ $this + set(int $offset, ImageInterface $image) +

-

Set an image at offset

-

-

-
+ + + +
+

Set an image at offset.

+

Parameters

- +
- + - + - +
integerint $offset -
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
OutOfBoundsException -OutOfBoundsException
+

See also

+ + + + + + +
+ LayersInterface::set +
+
-

-
at line 39
- public LayersInterface - remove(integer $offset) +

+
+

+
at line 54
+ $this + remove(int $offset) +

-

Removes the image at offset

-

-

-
+ + + +
+

Removes the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
+

See also

+ + + + + + +
+ LayersInterface::remove +
+
-

-
at line 49
- public ImageInterface - get(integer $offset) +

+
+

+
at line 66
+ ImageInterface + get(int $offset) +

-

Returns the image at offset

-

-

-
+ + + +
+

Returns the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
+

See also

+ + + + + + +
+ LayersInterface::get +
+
-

-
at line 57
- public Boolean - has(integer $offset) +

+
+

+
at line 76
+ bool + has(int $offset) +

-

Returns true if a layer at offset is preset

-

-

-
+ + + +
+

Returns true if a layer at offset is preset.

+

Parameters

- +
- + + + +
integerint $offset
+ + +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + + + +
+ LayersInterface::has +
+ +
+
+ +
+
+

+
at line 86
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + ClassFactoryAwareInterface::setClassFactory + +
-
+
+
+ +
+
+

+
at line 98
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+

Return Value

- +
- - + +
Boolean -ClassFactoryInterface
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Box.html b/docs/API/API/Imagine/Image/Box.html index 08931f45a..3c39a6e24 100644 --- a/docs/API/API/Imagine/Image/Box.html +++ b/docs/API/API/Imagine/Image/Box.html @@ -1,172 +1,234 @@ - - - - Imagine\Image\Box | - - - -
- - -
- -
Class
-

Imagine\Image\Box

+ + + + Imagine\Image\Box | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Box
    7. +
+
+
+ +
+

+ Box + +

+
+ +

class Box implements - BoxInterface

+ BoxInterface +

+ + +
-

A box implementation

-

-

-
+

A box implementation.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(integer $width, integer $height) -

Constructs the Size with given width and height

-
- integer - + +
+ __construct(int $width, int $height) + +

Constructs the Size with given width and height.

+
+ +
+
+ int +
+
getWidth() -

Gets current image width

-
- integer - + +

Gets box width.

+
+ +
+
+ int +
+
getHeight() -

Gets current image height

-
+ +

Gets box height.

+
+ +
+
BoxInterface -
+ +
scale(float $ratio) -

Creates new BoxInterface instance with ratios applied to both sides

-
+ +

Creates new BoxInterface instance with ratios applied to both sides.

+
+ +
+
BoxInterface -
- increase(integer $size) -

Creates new BoxInterface, adding given size to both sides

-
- Boolean - + +
+ increase(int $size) + +

Creates new BoxInterface, adding given size to both sides.

+
+ +
+
+ bool +
+
contains(BoxInterface $box, PointInterface $start = null) -

Checks whether current box can fit given box at a given start position, start position defaults to top left corner xy(0,0)

-
- integer - + +

Checks whether current box can fit given box at a given start position, +start position defaults to top left corner xy(0,0).

+
+ +
+
+ int +
+
square() -

Gets current box square, useful for getting total number of pixels in a given box

-
+ +

Gets current box square, useful for getting total number of pixels in a +given box.

+
+ +
+
string -
+ +
__toString() -

Returns a string representation of the current box

-
+ +

Returns a string representation of the current box.

+
+ +
+
BoxInterface -
- widen(integer $width) -

Resizes box to given width, constraining proportions and returns the new box

-
+ +
+ widen(int $width) + +

Resizes box to given width, constraining proportions and returns the new box.

+
+ +
+
BoxInterface -
- heighten(integer $height) -

Resizes box to given height, constraining proportions and returns the new box

-
+
+
+ heighten(int $height) + +

Resizes box to given height, constraining proportions and returns the new box.

+
+
+

Details

-

-
at line 39
- public - __construct(integer $width, integer $height) +
+
+

+
at line 39
+ + __construct(int $width, int $height) +

-

Constructs the Size with given width and height

-

-

-
+ + + +
+

Constructs the Size with given width and height.

+

Parameters

- +
- + - + - + - +
integerint $width -
integerint $height -
@@ -174,11 +236,10 @@

Parameters

Exceptions

- +
- - + +
InvalidArgumentException -InvalidArgumentException
@@ -186,305 +247,443 @@

Exceptions

-

-
at line 52
- public integer - getWidth() +

+
+

+
at line 59
+ int + getWidth() +

-

Gets current image width

-

-

-
+ + + +
+

Gets box width.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ BoxInterface::getWidth +
+
-

-
at line 60
- public integer - getHeight() +

+
+

+
at line 69
+ int + getHeight() +

-

Gets current image height

-

-

-
+ + + +
+

Gets box height.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ BoxInterface::getHeight +
+
-

-
at line 68
- public BoxInterface - scale(float $ratio) +

+
+

+
at line 79
+ BoxInterface + scale(float $ratio) +

-

Creates new BoxInterface instance with ratios applied to both sides

-

-

-
+ + + +
+

Creates new BoxInterface instance with ratios applied to both sides.

+

Parameters

- +
- +
float $ratio -

Return Value

- +
- +
BoxInterface -
+

See also

+ + + + + + +
+ BoxInterface::scale +
+
-

-
at line 76
- public BoxInterface - increase(integer $size) +

+
+

+
at line 92
+ BoxInterface + increase(int $size) +

-

Creates new BoxInterface, adding given size to both sides

-

-

-
+ + + +
+

Creates new BoxInterface, adding given size to both sides.

+

Parameters

- +
- + - +
integerint $size -

Return Value

- +
- +
BoxInterface -
+

See also

+ + + + + + +
+ BoxInterface::increase +
+
-

-
at line 84
- public Boolean - contains(BoxInterface $box, PointInterface $start = null) +

+
+

+
at line 102
+ bool + contains(BoxInterface $box, PointInterface $start = null) +

-

Checks whether current box can fit given box at a given start position, start position defaults to top left corner xy(0,0)

-

-

-
+ + + +
+

Checks whether current box can fit given box at a given start position, +start position defaults to top left corner xy(0,0).

+

Parameters

- +
- + - +
BoxInterface $box -
PointInterface $start -

Return Value

- +
- - + +
Boolean -bool
+

See also

+ + + + + + +
+ BoxInterface::contains +
+
-

-
at line 94
- public integer - square() +

+
+

+
at line 114
+ int + square() +

-

Gets current box square, useful for getting total number of pixels in a given box

-

-

-
+ + + +
+

Gets current box square, useful for getting total number of pixels in a +given box.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ BoxInterface::square +
+
-

-
at line 102
- public string - __toString() +

+
+

+
at line 124
+ string + __toString() +

-

Returns a string representation of the current box

-

-

-
+ + + +
+

Returns a string representation of the current box.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ BoxInterface::__toString +
+
-

-
at line 110
- public BoxInterface - widen(integer $width) +

+
+

+
at line 134
+ BoxInterface + widen(int $width) +

-

Resizes box to given width, constraining proportions and returns the new box

-

-

-
+ + + +
+

Resizes box to given width, constraining proportions and returns the new box.

+

Parameters

- +
- + - +
integerint $width -

Return Value

- +
- +
BoxInterface -
+

See also

+ + + + + + +
+ BoxInterface::widen +
+
-

-
at line 118
- public BoxInterface - heighten(integer $height) +

+
+

+
at line 144
+ BoxInterface + heighten(int $height) +

-

Resizes box to given height, constraining proportions and returns the new box

-

-

-
+ + + +
+

Resizes box to given height, constraining proportions and returns the new box.

+

Parameters

- +
- + - +
integerint $height -

Return Value

- +
- +
BoxInterface -
+

See also

+ + + + + + +
+ BoxInterface::heighten +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/BoxInterface.html b/docs/API/API/Imagine/Image/BoxInterface.html index 8c66b7f41..c814a27ce 100644 --- a/docs/API/API/Imagine/Image/BoxInterface.html +++ b/docs/API/API/Imagine/Image/BoxInterface.html @@ -1,155 +1,218 @@ - - - - Imagine\Image\BoxInterface | - - - -
- - -
- -
Interface
-

Imagine\Image\BoxInterface

+ + + + Imagine\Image\BoxInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

interface - BoxInterface

-
-

Interface for a box

-

-

+
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. BoxInterface
    7. +
+
+
+ +
+

+ BoxInterface + +

+
+ +

interface + BoxInterface +

+ + + + +
+

Interface for a box.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- integer - +
+
+
+ int +
+
getHeight() -

Gets current image height

-
- integer - + +

Gets box height.

+
+ +
+
+ int +
+
getWidth() -

Gets current image width

-
+ +

Gets box width.

+
+ +
+
BoxInterface -
+ +
scale(float $ratio) -

Creates new BoxInterface instance with ratios applied to both sides

-
+ +

Creates new BoxInterface instance with ratios applied to both sides.

+
+ +
+
BoxInterface -
- increase(integer $size) -

Creates new BoxInterface, adding given size to both sides

-
- Boolean - + +
+ increase(int $size) + +

Creates new BoxInterface, adding given size to both sides.

+
+ +
+
+ bool +
+
contains(BoxInterface $box, PointInterface $start = null) -

Checks whether current box can fit given box at a given start position, start position defaults to top left corner xy(0,0)

-
- integer - + +

Checks whether current box can fit given box at a given start position, +start position defaults to top left corner xy(0,0).

+
+ +
+
+ int +
+
square() -

Gets current box square, useful for getting total number of pixels in a given box

-
+ +

Gets current box square, useful for getting total number of pixels in a +given box.

+
+ +
+
string -
+ +
__toString() -

Returns a string representation of the current box

-
+ +

Returns a string representation of the current box.

+
+ +
+
BoxInterface -
- widen(integer $width) -

Resizes box to given width, constraining proportions and returns the new box

-
+ +
+ widen(int $width) + +

Resizes box to given width, constraining proportions and returns the new box.

+
+ +
+
BoxInterface -
- heighten(integer $height) -

Resizes box to given height, constraining proportions and returns the new box

-
+
+
+ heighten(int $height) + +

Resizes box to given height, constraining proportions and returns the new box.

+
+
+

Details

-

-
at line 24
- public integer - getHeight() +
+
+

+
at line 24
+ int + getHeight() +

-

Gets current image height

-

-

-
+ + + +
+

Gets box height.

+

Return Value

- +
- - + +
integer -int
@@ -158,24 +221,28 @@

Return Value

-

-
at line 31
- public integer - getWidth() +

+
+

+
at line 31
+ int + getWidth() +

-

Gets current image width

-

-

-
+ + + +
+

Gets box width.

+

Return Value

- +
- - + +
integer -int
@@ -184,35 +251,38 @@

Return Value

-

-
at line 40
- public BoxInterface - scale(float $ratio) +

+
+

+
at line 40
+ BoxInterface + scale(float $ratio) +

-

Creates new BoxInterface instance with ratios applied to both sides

-

-

-
+ + + +
+

Creates new BoxInterface instance with ratios applied to both sides.

+

Parameters

- +
- +
float $ratio -

Return Value

- +
- +
BoxInterface -
@@ -221,35 +291,38 @@

Return Value

-

-
at line 49
- public BoxInterface - increase(integer $size) +

+
+

+
at line 49
+ BoxInterface + increase(int $size) +

-

Creates new BoxInterface, adding given size to both sides

-

-

-
+ + + +
+

Creates new BoxInterface, adding given size to both sides.

+

Parameters

- +
- + - +
integerint $size -

Return Value

- +
- +
BoxInterface -
@@ -258,41 +331,44 @@

Return Value

-

-
at line 60
- public Boolean - contains(BoxInterface $box, PointInterface $start = null) +

+
+

+
at line 60
+ bool + contains(BoxInterface $box, PointInterface $start = null) +

-

Checks whether current box can fit given box at a given start position, start position defaults to top left corner xy(0,0)

-

-

-
+ + + +
+

Checks whether current box can fit given box at a given start position, +start position defaults to top left corner xy(0,0).

+

Parameters

- +
- + - +
BoxInterface $box -
PointInterface $start -

Return Value

- +
- - + +
Boolean -bool
@@ -301,24 +377,29 @@

Return Value

-

-
at line 68
- public integer - square() +

+
+

+
at line 68
+ int + square() +

-

Gets current box square, useful for getting total number of pixels in a given box

-

-

-
+ + + +
+

Gets current box square, useful for getting total number of pixels in a +given box.

+

Return Value

- +
- - + +
integer -int
@@ -327,24 +408,28 @@

Return Value

-

-
at line 75
- public string - __toString() +

+
+

+
at line 75
+ string + __toString() +

-

Returns a string representation of the current box

-

-

-
+ + + +
+

Returns a string representation of the current box.

+

Return Value

- +
- +
string -
@@ -353,35 +438,38 @@

Return Value

-

-
at line 84
- public BoxInterface - widen(integer $width) +

+
+

+
at line 84
+ BoxInterface + widen(int $width) +

-

Resizes box to given width, constraining proportions and returns the new box

-

-

-
+ + + +
+

Resizes box to given width, constraining proportions and returns the new box.

+

Parameters

- +
- + - +
integerint $width -

Return Value

- +
- +
BoxInterface -
@@ -390,35 +478,38 @@

Return Value

-

-
at line 93
- public BoxInterface - heighten(integer $height) +

+
+

+
at line 93
+ BoxInterface + heighten(int $height) +

-

Resizes box to given height, constraining proportions and returns the new box

-

-

-
+ + + +
+

Resizes box to given height, constraining proportions and returns the new box.

+

Parameters

- +
- + - +
integerint $height -

Return Value

- +
- +
BoxInterface -
@@ -427,10 +518,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Fill.html b/docs/API/API/Imagine/Image/Fill.html index 5baf2924f..cc6a1981c 100644 --- a/docs/API/API/Imagine/Image/Fill.html +++ b/docs/API/API/Imagine/Image/Fill.html @@ -1,40 +1,107 @@ - - - - Imagine\Image\Fill | - - - -
- - -
- -
Namespace
-

Imagine\Image\Fill

+ + + + Imagine\Image\Fill | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Fill
  7. \
    8. +
-
+
+
+

Imagine\Image\Fill

+
+ +

Namespaces

+
+ Imagine\Image\Fill\Gradient
+ +

Interfaces

- - - - - -
FillInterfaceInterface for the fill
+ +
+
+
+ FillInterface + +
+
+ Interface for the fill. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Fill/FillInterface.html b/docs/API/API/Imagine/Image/Fill/FillInterface.html index 72c97d0ad..59f82f9ce 100644 --- a/docs/API/API/Imagine/Image/Fill/FillInterface.html +++ b/docs/API/API/Imagine/Image/Fill/FillInterface.html @@ -1,86 +1,146 @@ - - - - Imagine\Image\Fill\FillInterface | - - - -
- + + + + Imagine\Image\Fill\FillInterface | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Interface
-

Imagine\Image\Fill\FillInterface

+ +
+
+
+ +
+ + +
-
-

interface - FillInterface

-
-

Interface for the fill

-

-

+
+
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Fill
  7. \
  8. FillInterface
    9. +
+
+
+ +
+

+ FillInterface + +

+
+ +

interface + FillInterface +

+ + + + +
+

Interface for the fill.

+

Methods

- - - - - - -
+
+
+
ColorInterface -
+ +
getColor(PointInterface $position) -

Gets color of the fill for the given position

-
+ +

Gets color of the fill for the given position.

+
+
+

Details

-

-
at line 29
- public ColorInterface - getColor(PointInterface $position) +
+
+

+
at line 28
+ ColorInterface + getColor(PointInterface $position) +

-

Gets color of the fill for the given position

-

-

-
+ + + +
+

Gets color of the fill for the given position.

+

Parameters

- +
- +
PointInterface $position -

Return Value

- +
- +
ColorInterface -
@@ -89,10 +149,17 @@

Return Value

+
+
+
-

+ diff --git a/docs/API/API/Imagine/Image/Fill/Gradient.html b/docs/API/API/Imagine/Image/Fill/Gradient.html index c2521c2ae..d64074184 100644 --- a/docs/API/API/Imagine/Image/Fill/Gradient.html +++ b/docs/API/API/Imagine/Image/Fill/Gradient.html @@ -1,47 +1,122 @@ - - - - Imagine\Image\Fill\Gradient | - - - -
- - -
- -
Namespace
-

Imagine\Image\Fill\Gradient

+ + + + Imagine\Image\Fill\Gradient | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Fill
  7. \
  8. Gradient
  9. \
    10. +
+
+
+ +
+

Imagine\Image\Fill\Gradient

-
- - - - - - - - - - - - - -
HorizontalHorizontal gradient fill
LinearLinear gradient fill
VerticalVertical gradient fill
+ + +

Classes

+ +
+
+
+ Horizontal + +
+
+ Horizontal gradient fill. +
+
+
+
+ Linear + +
+
+ Linear gradient fill. +
+
+
+
+ Vertical + +
+
+ Vertical gradient fill. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Fill/Gradient/Horizontal.html b/docs/API/API/Imagine/Image/Fill/Gradient/Horizontal.html index 7e500988f..690394b23 100644 --- a/docs/API/API/Imagine/Image/Fill/Gradient/Horizontal.html +++ b/docs/API/API/Imagine/Image/Fill/Gradient/Horizontal.html @@ -1,129 +1,190 @@ - - - - Imagine\Image\Fill\Gradient\Horizontal | - - - -
- + + + + Imagine\Image\Fill\Gradient\Horizontal | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Image\Fill\Gradient\Horizontal

+ +
+
+
+ +
+ + +
-
-

class - Horizontal extends Linear

-
-

Horizontal gradient fill

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Fill
  7. \
  8. Gradient
  9. \
  10. Horizontal
    11. +
+
+
+ +
+

+ Horizontal + +

+
+ +

class + Horizontal extends Linear +

+ + + + +
+

Horizontal gradient fill.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(integer $length, ColorInterface $start, ColorInterface $end) -

Constructs a linear gradient with overall gradient length, and start and end shades, which default to 0 and 255 accordingly

- 		from Linear
+ +
+ __construct(int $length, ColorInterface $start, ColorInterface $end) + +

Constructs a linear gradient with overall gradient length, and start and +end shades, which default to 0 and 255 accordingly.

+
from Linear
+ +
+
ColorInterface -
+ +
getColor(PointInterface $position) -

Gets color of the fill for the given position

-
from Linear
+ +

Gets color of the fill for the given position.

+
from Linear
+ +
+
ColorInterface -
+ +
getStart() -

-

-
from Linear
+ +

No description

+ +
from Linear
+ +
+
ColorInterface -
+ +
getEnd() -

-

-
from Linear
- - + +

No description

+ +
from Linear
+ +
+
+ int +
+
getDistance(PointInterface $position) -

{@inheritdoc}

-
+ +

Get the distance of the position relative to the beginning of the gradient.

+
+
+

Details

-

-
in Linear at line 46
- final public - __construct(integer $length, ColorInterface $start, ColorInterface $end) +
+
+

+
in Linear at line 46
+ final + __construct(int $length, ColorInterface $start, ColorInterface $end) +

-

Constructs a linear gradient with overall gradient length, and start and end shades, which default to 0 and 255 accordingly

-

-

-
+ + + +
+

Constructs a linear gradient with overall gradient length, and start and +end shades, which default to 0 and 255 accordingly.

+

Parameters

- +
- + - + - + - +
integerint $length -
ColorInterface $start -
ColorInterface $end -
@@ -133,62 +194,77 @@

Parameters

-

-
in Linear at line 56
- final public ColorInterface - getColor(PointInterface $position) +

+
+

+
in Linear at line 58
+ final ColorInterface + getColor(PointInterface $position) +

-

Gets color of the fill for the given position

-

-

-
+ + + +
+

Gets color of the fill for the given position.

+

Parameters

- +
- +
PointInterface $position -

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ FillInterface::getColor +
+
-

-
in Linear at line 74
- final public ColorInterface - getStart() +

+
+

+
in Linear at line 76
+ final ColorInterface + getStart() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
ColorInterface -
@@ -197,25 +273,26 @@

Return Value

-

-
in Linear at line 82
- final public ColorInterface - getEnd() +

+
+

+
in Linear at line 84
+ final ColorInterface + getEnd() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
ColorInterface -
@@ -224,37 +301,68 @@

Return Value

-

-
at line 24
- public - getDistance(PointInterface $position) +

+
+

+
at line 26
+ int + getDistance(PointInterface $position) +

-

{@inheritdoc}

-

-

-
+ + + +
+

Get the distance of the position relative to the beginning of the gradient.

+

Parameters

- +
- +
PointInterface $position -
+

Return Value

+ + + + + + +
int
+ +

See also

+ + + + + + +
+ Linear::getDistance +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Fill/Gradient/Linear.html b/docs/API/API/Imagine/Image/Fill/Gradient/Linear.html index 090c5e4a3..4c0fc1039 100644 --- a/docs/API/API/Imagine/Image/Fill/Gradient/Linear.html +++ b/docs/API/API/Imagine/Image/Fill/Gradient/Linear.html @@ -1,120 +1,191 @@ - - - - Imagine\Image\Fill\Gradient\Linear | - - - -
- - -
- -
Class
-

Imagine\Image\Fill\Gradient\Linear

+ + + + Imagine\Image\Fill\Gradient\Linear | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Fill
  7. \
  8. Gradient
  9. \
  10. Linear
    11. +
+
+
+ +
+

+ Linear + +

-
-

abstract class + +

abstract class Linear implements - FillInterface

+ FillInterface +

+ + +
-

Linear gradient fill

-

-

-
+

Linear gradient fill.

+

Methods

- - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(integer $length, ColorInterface $start, ColorInterface $end) -

Constructs a linear gradient with overall gradient length, and start and end shades, which default to 0 and 255 accordingly

-
+ +
+ __construct(int $length, ColorInterface $start, ColorInterface $end) + +

Constructs a linear gradient with overall gradient length, and start and +end shades, which default to 0 and 255 accordingly.

+
+ +
+
ColorInterface -
+ +
getColor(PointInterface $position) -

Gets color of the fill for the given position

-
+ +

Gets color of the fill for the given position.

+
+ +
+
ColorInterface -
+ +
getStart() -

-

-
+ +

No description

+ +
+ +
+
ColorInterface -
+ +
getEnd() -

-

-
+ +

No description

+
+
+
+
+
+ int +
+
+ getDistance(PointInterface $position) + +

Get the distance of the position relative to the beginning of the gradient.

+
+
+

Details

-

-
at line 46
- final public - __construct(integer $length, ColorInterface $start, ColorInterface $end) +
+
+

+
at line 46
+ final + __construct(int $length, ColorInterface $start, ColorInterface $end) +

-

Constructs a linear gradient with overall gradient length, and start and end shades, which default to 0 and 255 accordingly

-

-

-
+ + + +
+

Constructs a linear gradient with overall gradient length, and start and +end shades, which default to 0 and 255 accordingly.

+

Parameters

- +
- + - + - + - +
integerint $length -
ColorInterface $start -
ColorInterface $end -
@@ -124,62 +195,77 @@

Parameters

-

-
at line 56
- final public ColorInterface - getColor(PointInterface $position) +

+
+

+
at line 58
+ final ColorInterface + getColor(PointInterface $position) +

-

Gets color of the fill for the given position

-

-

-
+ + + +
+

Gets color of the fill for the given position.

+

Parameters

- +
- +
PointInterface $position -

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ FillInterface::getColor +
+
-

-
at line 74
- final public ColorInterface - getStart() +

+
+

+
at line 76
+ final ColorInterface + getStart() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
ColorInterface -
@@ -188,25 +274,26 @@

Return Value

-

-
at line 82
- final public ColorInterface - getEnd() +

+
+

+
at line 84
+ final ColorInterface + getEnd() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
ColorInterface -
@@ -215,10 +302,57 @@

Return Value

+
+
+

+
at line 96
+ abstract protected int + getDistance(PointInterface $position) + +

+
+ + +
+

Get the distance of the position relative to the beginning of the gradient.

+
+

Parameters

+ + + + + + + +
PointInterface$position
+ + +

Return Value

+ + + + + + +
int
+ + + +
+
+ +
- + + +
+ diff --git a/docs/API/API/Imagine/Image/Fill/Gradient/Vertical.html b/docs/API/API/Imagine/Image/Fill/Gradient/Vertical.html index 9ccbe819b..3956ffafc 100644 --- a/docs/API/API/Imagine/Image/Fill/Gradient/Vertical.html +++ b/docs/API/API/Imagine/Image/Fill/Gradient/Vertical.html @@ -1,129 +1,190 @@ - - - - Imagine\Image\Fill\Gradient\Vertical | - - - -
- + + + + Imagine\Image\Fill\Gradient\Vertical | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Class
-

Imagine\Image\Fill\Gradient\Vertical

+ +
+
+
+ +
+ + +
-
-

class - Vertical extends Linear

-
-

Vertical gradient fill

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Fill
  7. \
  8. Gradient
  9. \
  10. Vertical
    11. +
+
+
+ +
+

+ Vertical + +

+
+ +

class + Vertical extends Linear +

+ + + + +
+

Vertical gradient fill.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(integer $length, ColorInterface $start, ColorInterface $end) -

Constructs a linear gradient with overall gradient length, and start and end shades, which default to 0 and 255 accordingly

- 		from Linear
+ +
+ __construct(int $length, ColorInterface $start, ColorInterface $end) + +

Constructs a linear gradient with overall gradient length, and start and +end shades, which default to 0 and 255 accordingly.

+
from Linear
+ +
+
ColorInterface -
+ +
getColor(PointInterface $position) -

Gets color of the fill for the given position

-
from Linear
+ +

Gets color of the fill for the given position.

+
from Linear
+ +
+
ColorInterface -
+ +
getStart() -

-

-
from Linear
+ +

No description

+ +
from Linear
+ +
+
ColorInterface -
+ +
getEnd() -

-

-
from Linear
- - + +

No description

+ +
from Linear
+ +
+
+ int +
+
getDistance(PointInterface $position) -

{@inheritdoc}

-
+ +

Get the distance of the position relative to the beginning of the gradient.

+
+
+

Details

-

-
in Linear at line 46
- final public - __construct(integer $length, ColorInterface $start, ColorInterface $end) +
+
+

+
in Linear at line 46
+ final + __construct(int $length, ColorInterface $start, ColorInterface $end) +

-

Constructs a linear gradient with overall gradient length, and start and end shades, which default to 0 and 255 accordingly

-

-

-
+ + + +
+

Constructs a linear gradient with overall gradient length, and start and +end shades, which default to 0 and 255 accordingly.

+

Parameters

- +
- + - + - + - +
integerint $length -
ColorInterface $start -
ColorInterface $end -
@@ -133,62 +194,77 @@

Parameters

-

-
in Linear at line 56
- final public ColorInterface - getColor(PointInterface $position) +

+
+

+
in Linear at line 58
+ final ColorInterface + getColor(PointInterface $position) +

-

Gets color of the fill for the given position

-

-

-
+ + + +
+

Gets color of the fill for the given position.

+

Parameters

- +
- +
PointInterface $position -

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ FillInterface::getColor +
+
-

-
in Linear at line 74
- final public ColorInterface - getStart() +

+
+

+
in Linear at line 76
+ final ColorInterface + getStart() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
ColorInterface -
@@ -197,25 +273,26 @@

Return Value

-

-
in Linear at line 82
- final public ColorInterface - getEnd() +

+
+

+
in Linear at line 84
+ final ColorInterface + getEnd() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
ColorInterface -
@@ -224,37 +301,68 @@

Return Value

-

-
at line 24
- public - getDistance(PointInterface $position) +

+
+

+
at line 26
+ int + getDistance(PointInterface $position) +

-

{@inheritdoc}

-

-

-
+ + + +
+

Get the distance of the position relative to the beginning of the gradient.

+

Parameters

- +
- +
PointInterface $position -
+

Return Value

+ + + + + + +
int
+ +

See also

+ + + + + + +
+ Linear::getDistance +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Fill/Gradient/namespace-frame.html b/docs/API/API/Imagine/Image/Fill/Gradient/namespace-frame.html deleted file mode 100644 index 719a35b5c..000000000 --- a/docs/API/API/Imagine/Image/Fill/Gradient/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Image\Fill\Gradient | - - - diff --git a/docs/API/API/Imagine/Image/Fill/namespace-frame.html b/docs/API/API/Imagine/Image/Fill/namespace-frame.html deleted file mode 100644 index 2434a7ef2..000000000 --- a/docs/API/API/Imagine/Image/Fill/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Image\Fill | - - - diff --git a/docs/API/API/Imagine/Image/FontInterface.html b/docs/API/API/Imagine/Image/FontInterface.html index 1f69ba793..e0129ec3e 100644 --- a/docs/API/API/Imagine/Image/FontInterface.html +++ b/docs/API/API/Imagine/Image/FontInterface.html @@ -1,105 +1,176 @@ - - - - Imagine\Image\FontInterface | - - - -
- - -
- -
Interface
-

Imagine\Image\FontInterface

+ + + + Imagine\Image\FontInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

interface - FontInterface

-
-

The font interface

-

-

+
+
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. FontInterface
    7. +
+
+
+ +
+

+ FontInterface + +

+
+ +

interface + FontInterface +

+ + + + +
+

The font interface.

+

Methods

- - - - - - - - - - - - - - - - - - - - - -
+
+
+
string -
+ +
getFile() -

Gets the fontfile for current font

-
- integer - + +

Gets the fontfile for current font.

+
+ +
+
+ int +
+
getSize() -

Gets font's integer point size

-
+ +

Gets font's integer point size.

+
+ +
+
ColorInterface -
+ +
getColor() -

Gets font's color

-
+ +

Gets font's color.

+
+ +
+
BoxInterface -
- box(string $string, integer $angle) -

Gets BoxInterface of font size on the image based on string and angle

-
+
+
+ box(string $string, int $angle = 0) + +

Gets BoxInterface of font size on the image based on string and angle.

+
+
+
+
+ string +
+
+ wrapText(string $string, int $maxWidth, int $angle = 0) + +

Split a string into multiple lines so that it fits a specific width.

+
+
+

Details

-

-
at line 26
- public string - getFile() +
+
+

+
at line 24
+ string + getFile() +

-

Gets the fontfile for current font

-

-

-
+ + + +
+

Gets the fontfile for current font.

+

Return Value

- +
- +
string -
@@ -108,24 +179,28 @@

Return Value

-

-
at line 33
- public integer - getSize() +

+
+

+
at line 31
+ int + getSize() +

-

Gets font's integer point size

-

-

-
+ + + +
+

Gets font's integer point size.

+

Return Value

- +
- - + +
integer -int
@@ -134,24 +209,28 @@

Return Value

-

-
at line 40
- public ColorInterface - getColor() +

+
+

+
at line 38
+ ColorInterface + getColor() +

-

Gets font's color

-

-

-
+ + + +
+

Gets font's color.

+

Return Value

- +
- +
ColorInterface -
@@ -160,41 +239,93 @@

Return Value

-

-
at line 50
- public BoxInterface - box(string $string, integer $angle) +

+
+

+
at line 48
+ BoxInterface + box(string $string, int $angle = 0) +

-

Gets BoxInterface of font size on the image based on string and angle

-

-

-
+ + + +
+

Gets BoxInterface of font size on the image based on string and angle.

+

Parameters

- +
- + - + - +
string $string -
integerint $angle -

Return Value

- +
- + + +
BoxInterface -
+ + + +
+
+ +
+
+

+
at line 59
+ string + wrapText(string $string, int $maxWidth, int $angle = 0) + +

+
+ + + +
+

Split a string into multiple lines so that it fits a specific width.

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
string$stringThe text to be wrapped
int$maxWidthThe maximum width of the text
int$angle
+ + +

Return Value

+ + + + +
string
@@ -203,10 +334,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Histogram.html b/docs/API/API/Imagine/Image/Histogram.html index 45e3319be..e155f0e1d 100644 --- a/docs/API/API/Imagine/Image/Histogram.html +++ b/docs/API/API/Imagine/Image/Histogram.html @@ -1,43 +1,113 @@ - - - - Imagine\Image\Histogram | - - - -
- - -
- -
Namespace
-

Imagine\Image\Histogram

+ + + + Imagine\Image\Histogram | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Histogram
  7. \
    8. +
-
- - - - - - - - - -
BucketBucket histogram
RangeRange histogram
+
+ +
+

Imagine\Image\Histogram

+
+ + +

Classes

+ +
+
+
+ Bucket + +
+
+ Bucket histogram. +
+
+
+
+ Range + +
+
+ Range histogram. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Histogram/Bucket.html b/docs/API/API/Imagine/Image/Histogram/Bucket.html index e408746c6..f0a888f69 100644 --- a/docs/API/API/Imagine/Image/Histogram/Bucket.html +++ b/docs/API/API/Imagine/Image/Histogram/Bucket.html @@ -1,106 +1,163 @@ - - - - Imagine\Image\Histogram\Bucket | - - - -
- + + + + Imagine\Image\Histogram\Bucket | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
-
+
+
+ -
Class
-

Imagine\Image\Histogram\Bucket

+
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Histogram
  7. \
  8. Bucket
    9. +
+
+
+ +
+

+ Bucket + +

-
-

class + +

class Bucket implements - Countable

+ Countable +

+ + +
-

Bucket histogram

-

-

-
+

Bucket histogram.

+

Methods

- - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(Range $range, integer $count) -

-

-
- - - add(integer $value) -

-

-
- integer - + +
+ __construct(Range $range, int $count = 0) + +

No description

+
+
+ +
+
+ $this +
+
+ add(int $value) + +

No description

+
+
+
+
+
+ int +
+
count() -

-

-
+ +

No description

+
+
+
+

Details

-

-
at line 33
- public - __construct(Range $range, integer $count) +
+
+

+
at line 33
+ + __construct(Range $range, int $count = 0) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - + - +
Range $range -
integerint $count -
@@ -110,52 +167,64 @@

Parameters

-

-
at line 42
- public - add(integer $value) +

+
+

+
at line 44
+ $this + add(int $value) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - +
integerint $value -
+

Return Value

+ + + + + + +
$this
+
-

-
at line 52
- public integer - count() +

+
+

+
at line 56
+ int + count() +

-

-

-

-

-
+ + + +

Return Value

- +
- - + +
integerThe number of elements in the bucket.intthe number of elements in the bucket
@@ -164,10 +233,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Histogram/Range.html b/docs/API/API/Imagine/Image/Histogram/Range.html index 476eaa97b..a1adae1f0 100644 --- a/docs/API/API/Imagine/Image/Histogram/Range.html +++ b/docs/API/API/Imagine/Image/Histogram/Range.html @@ -1,94 +1,151 @@ - - - - Imagine\Image\Histogram\Range | - - - -
- + + + + Imagine\Image\Histogram\Range | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
-
+
-
Class
-

Imagine\Image\Histogram\Range

+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Histogram
  7. \
  8. Range
    9. +
+
+
+ +
+

+ Range + +

-
-

class - Range

-
-

Range histogram

-

+

class + Range

-
+ + + + +
+

Range histogram.

+

Methods

- - - - - - - - - - - -
+
+
+
-
- __construct(integer $start, integer $end) -

-

-
- Boolean - - contains(integer $value) -

-

-
+
+
+ __construct(int $start, int $end) + +

No description

+
+
+
+
+
+ bool +
+
+ contains(int $value) + +

No description

+
+
+
+

Details

-

-
at line 37
- public - __construct(integer $start, integer $end) +
+
+

+
at line 37
+ + __construct(int $start, int $end) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - + - + - +
integerint $start -
integerint $end -
@@ -96,11 +153,10 @@

Parameters

Exceptions

- +
- - + +
OutOfBoundsException -OutOfBoundsException
@@ -108,36 +164,36 @@

Exceptions

-

-
at line 52
- public Boolean - contains(integer $value) +

+
+

+
at line 52
+ bool + contains(int $value) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - +
integerint $value -

Return Value

- +
- - + +
Boolean -bool
@@ -146,10 +202,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Histogram/namespace-frame.html b/docs/API/API/Imagine/Image/Histogram/namespace-frame.html deleted file mode 100644 index a22b5af10..000000000 --- a/docs/API/API/Imagine/Image/Histogram/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Image\Histogram | - - - diff --git a/docs/API/API/Imagine/Image/ImageInterface.html b/docs/API/API/Imagine/Image/ImageInterface.html index 7787d4671..bdc4c0098 100644 --- a/docs/API/API/Imagine/Image/ImageInterface.html +++ b/docs/API/API/Imagine/Image/ImageInterface.html @@ -1,237 +1,250 @@ - - - - Imagine\Image\ImageInterface | - - - -
- - -
- -
Interface
-

Imagine\Image\ImageInterface

+ + + + Imagine\Image\ImageInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. ImageInterface
    7. +
+
+
+ +
+

+ ImageInterface + +

-
-

interface + +

interface ImageInterface implements - ManipulatorInterface

+ ManipulatorInterface +

+ + +
-

The image interface

-

-

-
+

The image interface.

+

Constants

- +
RESOLUTION_PIXELSPERINCH -

-

-

-

+

Resolution units: pixels per inch.

+

RESOLUTION_PIXELSPERCENTIMETER -

-

-

-

+

Resolution units: pixels per centimeter.

+

INTERLACE_NONE -

-

-

-

+

Image interlacing: none.

+

INTERLACE_LINE -

-

-

-

+

Image interlacing: scanline.

+

INTERLACE_PLANE -

-

-

-

+

Image interlacing: plane.

+

INTERLACE_PARTITION -

-

-

-

+

Image interlacing: like plane interlacing except the different planes are saved to individual files.

+

FILTER_UNDEFINED -

-

-

-

+

Image filter: none/undefined.

+

FILTER_POINT -

-

-

-

+

Resampling filter: point (interpolated).

+

FILTER_BOX -

-

-

-

+

Resampling filter: box.

+

FILTER_TRIANGLE -

-

-

-

+

Resampling filter: triangle.

+

FILTER_HERMITE -

-

-

-

+

Resampling filter: hermite.

+

FILTER_HANNING -

-

-

-

+

Resampling filter: hanning.

+

FILTER_HAMMING -

-

-

-

+

Resampling filter: hamming.

+

FILTER_BLACKMAN -

-

-

-

+

Resampling filter: blackman.

+

FILTER_GAUSSIAN -

-

-

-

+

Resampling filter: gaussian.

+

FILTER_QUADRATIC -

-

-

-

+

Resampling filter: quadratic.

+

FILTER_CUBIC -

-

-

-

+

Resampling filter: cubic.

+

FILTER_CATROM -

-

-

-

+

Resampling filter: catrom.

+

FILTER_MITCHELL -

-

-

-

+

Resampling filter: mitchell.

+

FILTER_LANCZOS -

-

-

-

+

Resampling filter: lanczos.

+

FILTER_BESSEL -

-

-

-

+

Resampling filter: bessel.

+

FILTER_SINC -

-

-

-

+

Resampling filter: sinc.

+

@@ -240,312 +253,324 @@

Constants

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
ManipulatorInterface -
+ +
copy() -

Copies current source image into a new ImageInterface instance

-
from ManipulatorInterface
- ManipulatorInterface - + +

Copies current source image into a new ImageInterface instance.

+
from ManipulatorInterface
+ +
+
+ $this +
+
crop(PointInterface $start, BoxInterface $size) -

Crops a specified box out of the source image (modifies the source image) Returns cropped self

-
from ManipulatorInterface
- ManipulatorInterface - + +

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+
from ManipulatorInterface
+ +
+
+ $this +
+
resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) -

Resizes current image and returns self

-
from ManipulatorInterface
- ManipulatorInterface - - rotate(integer $angle, ColorInterface $background = null) -

Rotates an image at the given angle.

- 		from ManipulatorInterface
- ManipulatorInterface - - paste(ImageInterface $image, PointInterface $start) -

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

- 		from ManipulatorInterface
- ManipulatorInterface - + +

Resizes current image and returns self.

+
from ManipulatorInterface
+ +
+
+ $this +
+
+ rotate(int $angle, ColorInterface $background = null) + +

Rotates an image at the given angle.

+
from ManipulatorInterface
+
+
+
+ $this +
+
+ paste(ImageInterface $image, PointInterface $start, int $alpha = 100) + +

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

+
from ManipulatorInterface
+
+
+
+ $this +
+
save(string $path = null, array $options = array()) -

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

-
from ManipulatorInterface
- ManipulatorInterface - + +

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

+
from ManipulatorInterface
+ +
+
+ $this +
+
show(string $format, array $options = array()) -

Outputs the image content

-
from ManipulatorInterface
- ManipulatorInterface - + +

Outputs the image content.

+
from ManipulatorInterface
+ +
+
+ $this +
+
flipHorizontally() -

Flips current image using horizontal axis

-
from ManipulatorInterface
- ManipulatorInterface - + +

Flips current image using vertical axis.

+
from ManipulatorInterface
+ +
+
+ $this +
+
flipVertically() -

Flips current image using vertical axis

-
from ManipulatorInterface
- ManipulatorInterface - + +

Flips current image using horizontal axis.

+
from ManipulatorInterface
+ +
+
+ $this +
+
strip() -

Remove all profiles and comments

-
from ManipulatorInterface
- ManipulatorInterface - - thumbnail(BoxInterface $size, string $mode = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) -

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

- 		from ManipulatorInterface
+ +

Remove all profiles and comments.

+
from ManipulatorInterface
+ +
+
ManipulatorInterface -
+ +
+ thumbnail(BoxInterface $size, int|string $settings = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
from ManipulatorInterface
+ +
+
+ $this +
+
applyMask(ImageInterface $mask) -

Applies a given mask to current image's alpha channel

-
from ManipulatorInterface
- ManipulatorInterface - + +

Applies a given mask to current image's alpha channel.

+
from ManipulatorInterface
+ +
+
+ $this +
+
fill(FillInterface $fill) -

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

-
from ManipulatorInterface
+ +

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+
from ManipulatorInterface
+ +
+
string -
+ +
get(string $format, array $options = array()) -

Returns the image content as a binary string

-
+ +

Returns the image content as a binary string.

+
+ +
+
string -
+ +
__toString() -

Returns the image content as a PNG binary string

-
+ +

Returns the image content as a PNG binary string.

+
+ +
+
DrawerInterface -
+ +
draw() -

Instantiates and returns a DrawerInterface instance for image drawing

-
+ +

Instantiates and returns a DrawerInterface instance for image drawing.

+
+ +
+
EffectsInterface -
+ +
effects() -

-

-
+ +

No description

+ +
+ +
+
BoxInterface -
+ +
getSize() -

Returns current image size

-
+ +

Returns current image size.

+
+ +
+
ImageInterface -
+ +
mask() -

Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified

-
- array - + +

Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.

+
+ +
+
+ ColorInterface[] +
+
histogram() -

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances

-
+ +

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.

+
+ +
+
ColorInterface -
+ +
getColorAt(PointInterface $point) -

Returns color at specified positions of current image

-
+ +

Returns color at specified positions of current image.

+
+ +
+
LayersInterface -
+ +
layers() -

Returns the image layers when applicable.

-
- ImageInterface - + +

Returns the image layers when applicable.

+
+ +
+
+ $this +
+
interlace(string $scheme) -

Enables or disables interlacing

-
+ +

Enables or disables interlacing.

+
+ +
+
PaletteInterface -
+ +
palette() -

Return the current color palette

-
- ImageInterface - + +

Return the current color palette.

+
+ +
+
+ $this +
+
usePalette(PaletteInterface $palette) -

Set a palette for the image.

-
- ImageInterface - + +

Set a palette for the image. Useful to change colorspace.

+
+ +
+
+ $this +
+
profile(ProfileInterface $profile) -

Applies a color profile on the Image

-
- MetadataInterface - + +

Applies a color profile on the Image.

+
+ +
+
+ MetadataBag +
+
metadata() -

Returns the Image's meta data

-
+ +

Returns the Image's meta data.

+
+
+

Details

-

-
in ManipulatorInterface at line 34
- public ManipulatorInterface - copy() +
+
+

+
in ManipulatorInterface at line 57
+ ManipulatorInterface + copy() +

-

Copies current source image into a new ImageInterface instance

-

-

-
+ + + +
+

Copies current source image into a new ImageInterface instance.

+

Return Value

- +
- +
ManipulatorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -553,57 +578,58 @@

Exceptions

-

-
in ManipulatorInterface at line 48
- public ManipulatorInterface - crop(PointInterface $start, BoxInterface $size) +

+
+

+
in ManipulatorInterface at line 71
+ $this + crop(PointInterface $start, BoxInterface $size) +

-

Crops a specified box out of the source image (modifies the source image) Returns cropped self

-

-

-
+ + + +
+

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+

Parameters

- +
- + - +
PointInterface $start -
BoxInterface $size -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + +
OutOfBoundsException -OutOfBoundsException
RuntimeException -RuntimeException
@@ -611,52 +637,53 @@

Exceptions

-

-
in ManipulatorInterface at line 60
- public ManipulatorInterface - resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
in ManipulatorInterface at line 83
+ $this + resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Resizes current image and returns self

-

-

-
+ + + +
+

Resizes current image and returns self.

+

Parameters

- +
- + - +
BoxInterface $size -
string $filter -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -664,52 +691,54 @@

Exceptions

-

-
in ManipulatorInterface at line 74
- public ManipulatorInterface - rotate(integer $angle, ColorInterface $background = null) +

+
+

+
in ManipulatorInterface at line 97
+ $this + rotate(int $angle, ColorInterface $background = null) +

-

Rotates an image at the given angle.

-

Optional $background can be used to specify the fill color of the empty -area of rotated image.

-
+ + + +
+

Rotates an image at the given angle.

Optional $background can be used to specify the fill color of the empty +area of rotated image.

+

Parameters

- +
- + - + - +
integerint $angle -
ColorInterface $background -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -717,61 +746,64 @@

Exceptions

-

-
in ManipulatorInterface at line 92
- public ManipulatorInterface - paste(ImageInterface $image, PointInterface $start) +

+
+

+
in ManipulatorInterface at line 115
+ $this + paste(ImageInterface $image, PointInterface $start, int $alpha = 100) +

-

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

-

Returns source image

-
+ + + +
+

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

Returns source image

+

Parameters

- +
- + - + + + + + +
ImageInterface $image -
PointInterface $start -
int$alphaHow to paste the image, from 0 (fully transparent) to 100 (fully opaque)

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- - - - - +
InvalidArgumentException -
- - + + - - + +
OutOfBoundsException -InvalidArgumentException
RuntimeException -RuntimeException
@@ -779,52 +811,55 @@

Exceptions

-

-
in ManipulatorInterface at line 106
- public ManipulatorInterface - save(string $path = null, array $options = array()) +

+
+

+
in ManipulatorInterface at line 130
+ $this + save(string $path = null, array $options = array()) +

-

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

-

-

-
+ + + +
+

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

Please remark that bmp is supported by the GD driver only since PHP 7.2.

+

Parameters

- +
- + - +
string $path -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -832,52 +867,53 @@

Exceptions

-

-
in ManipulatorInterface at line 118
- public ManipulatorInterface - show(string $format, array $options = array()) +

+
+

+
in ManipulatorInterface at line 142
+ $this + show(string $format, array $options = array()) +

-

Outputs the image content

-

-

-
+ + + +
+

Outputs the image content.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -885,35 +921,38 @@

Exceptions

-

-
in ManipulatorInterface at line 127
- public ManipulatorInterface - flipHorizontally() +

+
+

+
in ManipulatorInterface at line 151
+ $this + flipHorizontally() +

-

Flips current image using horizontal axis

-

-

-
+ + + +
+

Flips current image using vertical axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -921,35 +960,38 @@

Exceptions

-

-
in ManipulatorInterface at line 136
- public ManipulatorInterface - flipVertically() +

+
+

+
in ManipulatorInterface at line 160
+ $this + flipVertically() +

-

Flips current image using vertical axis

-

-

-
+ + + +
+

Flips current image using horizontal axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -957,35 +999,38 @@

Exceptions

-

-
in ManipulatorInterface at line 145
- public ManipulatorInterface - strip() +

+
+

+
in ManipulatorInterface at line 169
+ $this + strip() +

-

Remove all profiles and comments

-

-

-
+ + + +
+

Remove all profiles and comments.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -993,30 +1038,34 @@

Exceptions

-

-
in ManipulatorInterface at line 159
- public ManipulatorInterface - thumbnail(BoxInterface $size, string $mode = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
in ManipulatorInterface at line 183
+ ManipulatorInterface + thumbnail(BoxInterface $size, int|string $settings = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

-

-

-
+ + + +
+

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+

Parameters

- +
- + - - - + + + @@ -1028,22 +1077,20 @@

Parameters

Return Value

-
BoxInterface $size -
string$mode -int|string$settingsOne or more of the ManipulatorInterface::THUMBNAIL_ flags (joined with |). It may be a string for backward compatibility with old constant values that were strings.
string
+
- +
ManipulatorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -1051,35 +1098,38 @@

Exceptions

-

-
in ManipulatorInterface at line 168
- public ManipulatorInterface - applyMask(ImageInterface $mask) +

+
+

+
in ManipulatorInterface at line 192
+ $this + applyMask(ImageInterface $mask) +

-

Applies a given mask to current image's alpha channel

-

-

-
+ + + +
+

Applies a given mask to current image's alpha channel.

+

Parameters

- +
- +
ImageInterface $mask -

Return Value

- +
- - + +
ManipulatorInterface -$this
@@ -1088,35 +1138,40 @@

Return Value

-

-
in ManipulatorInterface at line 179
- public ManipulatorInterface - fill(FillInterface $fill) +

+
+

+
in ManipulatorInterface at line 203
+ $this + fill(FillInterface $fill) +

-

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

-

-

-
+ + + +
+

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+

Parameters

- +
- +
FillInterface $fill -

Return Value

- +
- - + +
ManipulatorInterface -$this
@@ -1125,37 +1180,40 @@

Return Value

-

-
at line 61
- public string - get(string $format, array $options = array()) +

+
+

+
at line 185
+ string + get(string $format, array $options = array()) +

-

Returns the image content as a binary string

-

-

-
+ + + +
+

Returns the image content as a binary string.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
@@ -1165,11 +1223,10 @@

Return Value

Exceptions

-
string binary
+
- - + +
RuntimeException -RuntimeException
@@ -1177,20 +1234,25 @@

Exceptions

-

-
at line 70
- public string - __toString() +

+
+

+
at line 194
+ string + __toString() +

-

Returns the image content as a PNG binary string

-

-

-
+ + + +
+

Returns the image content as a PNG binary string.

+

Return Value

- +
@@ -1200,11 +1262,10 @@

Return Value

Exceptions

-
string binary
+
- - + +
RuntimeException -RuntimeException
@@ -1212,24 +1273,28 @@

Exceptions

-

-
at line 77
- public DrawerInterface - draw() +

+
+

+
at line 201
+ DrawerInterface + draw() +

-

Instantiates and returns a DrawerInterface instance for image drawing

-

-

-
+ + + +
+

Instantiates and returns a DrawerInterface instance for image drawing.

+

Return Value

- +
- +
DrawerInterface -
@@ -1238,25 +1303,26 @@

Return Value

-

-
at line 82
- public EffectsInterface - effects() +

+
+

+
at line 206
+ EffectsInterface + effects() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
EffectsInterface -
@@ -1265,24 +1331,28 @@

Return Value

-

-
at line 89
- public BoxInterface - getSize() +

+
+

+
at line 213
+ BoxInterface + getSize() +

-

Returns current image size

-

-

-
+ + + +
+

Returns current image size.

+

Return Value

- +
- +
BoxInterface -
@@ -1291,24 +1361,29 @@

Return Value

-

-
at line 97
- public ImageInterface - mask() +

+
+

+
at line 221
+ ImageInterface + mask() +

-

Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified

-

-

-
+ + + +
+

Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.

+

Return Value

- +
- +
ImageInterface -
@@ -1317,24 +1392,28 @@

Return Value

-

-
at line 104
- public array - histogram() +

+
+

+
at line 228
+ ColorInterface[] + histogram() +

-

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances

-

-

-
+ + + +
+

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.

+

Return Value

- +
- - + +
array -ColorInterface[]
@@ -1343,46 +1422,48 @@

Return Value

-

-
at line 115
- public ColorInterface - getColorAt(PointInterface $point) +

+
+

+
at line 239
+ ColorInterface + getColorAt(PointInterface $point) +

-

Returns color at specified positions of current image

-

-

-
+ + + +
+

Returns color at specified positions of current image.

+

Parameters

- +
- +
PointInterface $point -

Return Value

- +
- +
ColorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -1390,37 +1471,41 @@

Exceptions

-

-
at line 125
- public LayersInterface - layers() +

+
+

+
at line 249
+ LayersInterface + layers() +

-

Returns the image layers when applicable.

-

-

-
+ + + +
+

Returns the image layers when applicable.

+

Return Value

- +
- +
LayersInterface -

Exceptions

- +
- + - +
RuntimeExceptionRuntimeException In case the layer can not be returned
OutOfBoundsExceptionOutOfBoundsException In case the index is not a valid value
@@ -1429,44 +1514,47 @@

Exceptions

-

-
at line 136
- public ImageInterface - interlace(string $scheme) +

+
+

+
at line 260
+ $this + interlace(string $scheme) +

-

Enables or disables interlacing

-

-

-
+ + + +
+

Enables or disables interlacing.

+

Parameters

- +
- +
string $scheme -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException When an unsupported Interface type is supplied
@@ -1475,24 +1563,28 @@

Exceptions

-

-
at line 143
- public PaletteInterface - palette() +

+
+

+
at line 267
+ PaletteInterface + palette() +

-

Return the current color palette

-

-

-
+ + + +
+

Return the current color palette.

+

Return Value

- +
- +
PaletteInterface -
@@ -1501,45 +1593,48 @@

Return Value

-

-
at line 154
- public ImageInterface - usePalette(PaletteInterface $palette) +

+
+

+
at line 278
+ $this + usePalette(PaletteInterface $palette) +

-

Set a palette for the image.

-

Useful to change colorspace.

-
+ + + +
+

Set a palette for the image. Useful to change colorspace.

+

Parameters

- +
- +
PaletteInterface $palette -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -1547,46 +1642,48 @@

Exceptions

-

-
at line 165
- public ImageInterface - profile(ProfileInterface $profile) +

+
+

+
at line 289
+ $this + profile(ProfileInterface $profile) +

-

Applies a color profile on the Image

-

-

-
+ + + +
+

Applies a color profile on the Image.

+

Parameters

- +
- +
ProfileInterface $profile -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -1594,24 +1691,28 @@

Exceptions

-

-
at line 172
- public MetadataInterface - metadata() +

+
+

+
at line 296
+ MetadataBag + metadata() +

-

Returns the Image's meta data

-

-

-
+ + + +
+

Returns the Image's meta data.

+

Return Value

- +
- - + +
MetadataInterface -MetadataBag
@@ -1620,10 +1721,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/ImagineInterface.html b/docs/API/API/Imagine/Image/ImagineInterface.html index 5ebda5e00..902323840 100644 --- a/docs/API/API/Imagine/Image/ImagineInterface.html +++ b/docs/API/API/Imagine/Image/ImagineInterface.html @@ -1,47 +1,103 @@ - - - - Imagine\Image\ImagineInterface | - - - -
- - -
- -
Interface
-

Imagine\Image\ImagineInterface

+ + + + Imagine\Image\ImagineInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

interface - ImagineInterface

-
-

The imagine interface

-

-

+
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. ImagineInterface
    7. +
+
+ +
+

+ ImagineInterface + +

+
+ +

interface + ImagineInterface implements + ClassFactoryAwareInterface +

+ + + + +
+

The imagine interface.

+

Constants

- +
VERSION -

-

-

-

+

+

@@ -50,113 +106,223 @@

Constants

Methods

- - - - - - - - - - - - - - - - - - - - - - - - + +
+ font(string $file, int $size, ColorInterface $color) + +

Constructs a font with specified $file, $size and $color.

+
+ +
+
+ $this +
+
+ setMetadataReader(MetadataReaderInterface $metadataReader) + +

Set the object to be used to read image metadata.

+
+
+
+
+ MetadataReaderInterface +
+
+ getMetadataReader() + +

Get the object to be used to read image metadata.

+
+
+ + + +

Details

+ +
+
+

+
in ClassFactoryAwareInterface at line 17
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ +
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from ClassFactoryAwareInterface
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from ClassFactoryAwareInterface
+
+
+
ImageInterface -
+ +
create(BoxInterface $size, ColorInterface $color = null) -

Creates a new empty image with an optional background color

-
+ +

Creates a new empty image with an optional background color.

+
+ +
+
ImageInterface -
- open(string $path) -

Opens an existing image from $path

-
+ +
+ open(string|LoaderInterface|mixed $path) + +

Opens an existing image from $path.

+
+ +
+
ImageInterface -
+ +
load(string $string) -

Loads an image from a binary $string

-
+ +

Loads an image from a binary $string.

+
+ +
+
ImageInterface -
+ +
read(resource $resource) -

Loads an image from a resource $resource

-
+ +

Loads an image from a resource $resource.

+
+ +
+
FontInterface -
- font(string $file, integer $size, ColorInterface $color) -

Constructs a font with specified $file, $size and $color

-
+ + +
ClassFactoryInterface$classFactory
+ +

Return Value

+ + + + + + +
$this
-

Details

+ + +
+
-

-
at line 36
- public ImageInterface - create(BoxInterface $size, ColorInterface $color = null) +

+
+

+
in ClassFactoryAwareInterface at line 24
+ ClassFactoryInterface + getClassFactory() +

-

Creates a new empty image with an optional background color

-

-

-
+ + + +
+

Get the class factory instance to be used.

+
+ +

Return Value

+ + + + + + +
ClassFactoryInterface
+ + + +
+
+ +
+
+

+
at line 36
+ ImageInterface + create(BoxInterface $size, ColorInterface $color = null) + +

+
+ + + +
+

Creates a new empty image with an optional background color.

+

Parameters

- +
- + - +
BoxInterface $size -
ColorInterface $color -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + + - - + +
InvalidArgumentException -InvalidArgumentException
RuntimeException -RuntimeException
@@ -164,46 +330,48 @@

Exceptions

-

-
at line 47
- public ImageInterface - open(string $path) +

+
+

+
at line 47
+ ImageInterface + open(string|LoaderInterface|mixed $path) +

-

Opens an existing image from $path

-

-

-
+ + + +
+

Opens an existing image from $path.

+

Parameters

- +
- + - +
stringstring|LoaderInterface|mixed $path -the file path, a LoaderInterface instance, or an object whose string representation is the image path

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -211,46 +379,48 @@

Exceptions

-

-
at line 59
- public ImageInterface - load(string $string) +

+
+

+
at line 58
+ ImageInterface + load(string $string) +

-

Loads an image from a binary $string

-

-

-
+ + + +
+

Loads an image from a binary $string.

+

Parameters

- +
- +
string $string -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -258,46 +428,48 @@

Exceptions

-

-
at line 70
- public ImageInterface - read(resource $resource) +

+
+

+
at line 69
+ ImageInterface + read(resource $resource) +

-

Loads an image from a resource $resource

-

-

-
+ + + +
+

Loads an image from a resource $resource.

+

Parameters

- +
- +
resource $resource -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -305,46 +477,118 @@

Exceptions

-

-
at line 83
- public FontInterface - font(string $file, integer $size, ColorInterface $color) +

+
+

+
at line 82
+ FontInterface + font(string $file, int $size, ColorInterface $color) +

-

Constructs a font with specified $file, $size and $color

-

The font size is to be specified in points (e.g. 10pt means 10)

-
+ + + +
+

Constructs a font with specified $file, $size and $color.

The font size is to be specified in points (e.g. 10pt means 10)

+

Parameters

- +
- + - + - + - +
string $file -
integerint $size -
ColorInterface $color -

Return Value

- +
- + + +
FontInterface -
+ + + +
+
+ +
+
+

+
at line 91
+ $this + setMetadataReader(MetadataReaderInterface $metadataReader) + +

+
+ + + +
+

Set the object to be used to read image metadata.

+
+

Parameters

+ + + + + + + +
MetadataReaderInterface$metadataReader
+ + +

Return Value

+ + + + + + +
$this
+ + + +
+
+ +
+
+

+
at line 98
+ MetadataReaderInterface + getMetadataReader() + +

+
+ + + +
+

Get the object to be used to read image metadata.

+
+ +

Return Value

+ + + + +
MetadataReaderInterface
@@ -353,10 +597,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/LayersInterface.html b/docs/API/API/Imagine/Image/LayersInterface.html index 04f55a9f9..cec7d5ecd 100644 --- a/docs/API/API/Imagine/Image/LayersInterface.html +++ b/docs/API/API/Imagine/Image/LayersInterface.html @@ -1,147 +1,209 @@ - - - - Imagine\Image\LayersInterface | - - - -
- - -
- -
Interface
-

Imagine\Image\LayersInterface

+ + + + Imagine\Image\LayersInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. LayersInterface
    7. +
+
+
+ +
+

+ LayersInterface + +

-
-

interface + +

interface LayersInterface implements - Iterator, Countable, ArrayAccess

+ Iterator, Countable, ArrayAccess +

+ + +
-

The layers interface

-

-

-
+

The layers interface.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
+ +
merge() -

Merge layers into the original objects

-
- LayersInterface - - animate(string $format, integer $delay, integer $loops) -

Animates layers

-
- - + +

Merge layers into the original objects.

+
+ +
+
+ $this +
+
+ animate(string $format, int $delay, int $loops) + +

Animates layers.

+
+
+
+
+ $this +
+
coalesce() -

Coalesce layers.

-
- LayersInterface - + +

Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.

+
+ +
+
+ $this +
+
add(ImageInterface $image) -

Adds an image at the end of the layers stack

-
- LayersInterface - - set(integer $offset, ImageInterface $image) -

Set an image at offset

-
- LayersInterface - - remove(integer $offset) -

Removes the image at offset

-
+ +

Adds an image at the end of the layers stack.

+
+ +
+
+ $this +
+
+ set(int $offset, ImageInterface $image) + +

Set an image at offset.

+
+
+
+
+ $this +
+
+ remove(int $offset) + +

Removes the image at offset.

+
+
+
+
ImageInterface -
- get(integer $offset) -

Returns the image at offset

-
- Boolean - - has(integer $offset) -

Returns true if a layer at offset is preset

-
+
+
+ get(int $offset) + +

Returns the image at offset.

+
+
+
+
+ bool +
+
+ has(int $offset) + +

Returns true if a layer at offset is preset.

+
+
+

Details

-

-
at line 28
- public - merge() +
+
+

+
at line 24
+ + merge() +

-

Merge layers into the original objects

-

-

-
+ + + +
+

Merge layers into the original objects.

+

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -149,31 +211,36 @@

Exceptions

-

-
at line 42
- public LayersInterface - animate(string $format, integer $delay, integer $loops) +

+
+

+
at line 38
+ $this + animate(string $format, int $delay, int $loops) +

-

Animates layers

-

-

-
+ + + +
+

Animates layers.

+

Parameters

- +
- + - + @@ -182,24 +249,23 @@

Parameters

Return Value

-
string $format The output output format
integerint $delay The delay in milliseconds between two frames
integerint $loops The number of loops, 0 means infinite
+
- - + +
LayersInterface -$this

Exceptions

- +
- + - +
InvalidArgumentExceptionInvalidArgumentException In case an invalid argument is provided
RuntimeExceptionRuntimeException In case the driver fails to animate
@@ -208,62 +274,88 @@

Exceptions

-

-
at line 48
- public - coalesce() +

+
+

+
at line 48
+ $this + coalesce() +

-

Coalesce layers.

-

Each layer in the sequence is the same size as the first and composited with the next layer in -the sequence.

-
+ + +
+

Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.

+
+ +

Return Value

+ + + + + + +
$this
+ +

Exceptions

+ + + + + + +
NotSupportedException
+
-

-
at line 59
- public LayersInterface - add(ImageInterface $image) +

+
+

+
at line 59
+ $this + add(ImageInterface $image) +

-

Adds an image at the end of the layers stack

-

-

-
+ + + +
+

Adds an image at the end of the layers stack.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -271,62 +363,61 @@

Exceptions

-

-
at line 73
- public LayersInterface - set(integer $offset, ImageInterface $image) +

+
+

+
at line 73
+ $this + set(int $offset, ImageInterface $image) +

-

Set an image at offset

-

-

-
+ + + +
+

Set an image at offset.

+

Parameters

- +
- + - + - +
integerint $offset -
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
OutOfBoundsException -OutOfBoundsException
@@ -334,51 +425,52 @@

Exceptions

-

-
at line 85
- public LayersInterface - remove(integer $offset) +

+
+

+
at line 85
+ $this + remove(int $offset) +

-

Removes the image at offset

-

-

-
+ + + +
+

Removes the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
@@ -386,51 +478,52 @@

Exceptions

-

-
at line 97
- public ImageInterface - get(integer $offset) +

+
+

+
at line 97
+ ImageInterface + get(int $offset) +

-

Returns the image at offset

-

-

-
+ + + +
+

Returns the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
@@ -438,35 +531,38 @@

Exceptions

-

-
at line 106
- public Boolean - has(integer $offset) +

+
+

+
at line 106
+ bool + has(int $offset) +

-

Returns true if a layer at offset is preset

-

-

-
+ + + +
+

Returns true if a layer at offset is preset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- - + +
Boolean -bool
@@ -475,10 +571,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/ManipulatorInterface.html b/docs/API/API/Imagine/Image/ManipulatorInterface.html index 7b81905bd..d476e34fb 100644 --- a/docs/API/API/Imagine/Image/ManipulatorInterface.html +++ b/docs/API/API/Imagine/Image/ManipulatorInterface.html @@ -1,229 +1,307 @@ - - - - Imagine\Image\ManipulatorInterface | - - - -
- - -
- -
Interface
-

Imagine\Image\ManipulatorInterface

+ + + + Imagine\Image\ManipulatorInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

interface - ManipulatorInterface

-
-

The manipulator interface

-

-

+
+
- -

Constants

+
+ - - - - - - - - - -
THUMBNAIL_INSET -

-

-

-

-
THUMBNAIL_OUTBOUND -

-

-

+

+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. ManipulatorInterface
    7. +
+
+
+ +
+

+ ManipulatorInterface + +

+
+ +

interface + ManipulatorInterface

-
+ + +
+

The manipulator interface.

-

Methods

+ +

Constants

- - - - - - +
- ManipulatorInterface - - copy() -

Copies current source image into a new ImageInterface instance

-
- + - - + - - + - - + - - -
- ManipulatorInterface - THUMBNAIL_INSET - crop(PointInterface $start, BoxInterface $size) -

Crops a specified box out of the source image (modifies the source image) Returns cropped self

+

The original image is scaled so it is fully contained within the thumbnail dimensions (the image width/height ratio doesn't change).

+

- ManipulatorInterface - THUMBNAIL_OUTBOUND - resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) -

Resizes current image and returns self

+

The thumbnail is scaled so that its smallest side equals the length of the corresponding side in the original image (the width or the height are cropped).

+

- ManipulatorInterface - THUMBNAIL_FLAG_UPSCALE - rotate(integer $angle, ColorInterface $background = null) -

Rotates an image at the given angle.

+

Allow upscaling the image if it's smaller than the wanted thumbnail size.

+

- ManipulatorInterface - THUMBNAIL_FLAG_NOCLONE - paste(ImageInterface $image, PointInterface $start) -

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

+

Instead of creating a new image instance, the thumbnail method modifies the original image (saving memory.

+

+
+ + + +

Methods

+ +
+
+
ManipulatorInterface - - +
+
+ copy() + +

Copies current source image into a new ImageInterface instance.

+
+
+
+
+ $this +
+
+ crop(PointInterface $start, BoxInterface $size) + +

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+
+
+
+
+ $this +
+
+ resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) + +

Resizes current image and returns self.

+
+
+
+
+ $this +
+
+ rotate(int $angle, ColorInterface $background = null) + +

Rotates an image at the given angle.

+
+
+
+
+ $this +
+
+ paste(ImageInterface $image, PointInterface $start, int $alpha = 100) + +

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

+
+
+
+
+ $this +
+
save(string $path = null, array $options = array()) -

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

- - - - - - ManipulatorInterface - - + +

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

+
+
+
+
+ $this +
+
show(string $format, array $options = array()) -

Outputs the image content

- - - - - - ManipulatorInterface - - + +

Outputs the image content.

+
+
+
+
+ $this +
+
flipHorizontally() -

Flips current image using horizontal axis

- - - - - - ManipulatorInterface - - + +

Flips current image using vertical axis.

+
+
+
+
+ $this +
+
flipVertically() -

Flips current image using vertical axis

- - - - - - ManipulatorInterface - - + +

Flips current image using horizontal axis.

+
+
+
+
+ $this +
+
strip() -

Remove all profiles and comments

- - - - - - ManipulatorInterface - - - thumbnail(BoxInterface $size, string $mode = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) -

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

- - - - - + +

Remove all profiles and comments.

+
+
+
+
ManipulatorInterface - - +
+
+ thumbnail(BoxInterface $size, int|string $settings = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
+
+
+
+ $this +
+
applyMask(ImageInterface $mask) -

Applies a given mask to current image's alpha channel

- - - - - - ManipulatorInterface - - + +

Applies a given mask to current image's alpha channel.

+
+
+
+
+ $this +
+
fill(FillInterface $fill) -

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

- - - - + +

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+
+
+

Details

-

-
at line 34
- public ManipulatorInterface - copy() +
+
+

+
at line 57
+ ManipulatorInterface + copy() +

-

Copies current source image into a new ImageInterface instance

-

-

-
+ + + +
+

Copies current source image into a new ImageInterface instance.

+

Return Value

- +
- +
ManipulatorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -231,57 +309,58 @@

Exceptions

-

-
at line 48
- public ManipulatorInterface - crop(PointInterface $start, BoxInterface $size) +

+
+

+
at line 71
+ $this + crop(PointInterface $start, BoxInterface $size) +

-

Crops a specified box out of the source image (modifies the source image) Returns cropped self

-

-

-
+ + + +
+

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+

Parameters

- +
- + - +
PointInterface $start -
BoxInterface $size -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + +
OutOfBoundsException -OutOfBoundsException
RuntimeException -RuntimeException
@@ -289,52 +368,53 @@

Exceptions

-

-
at line 60
- public ManipulatorInterface - resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
at line 83
+ $this + resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Resizes current image and returns self

-

-

-
+ + + +
+

Resizes current image and returns self.

+

Parameters

- +
- + - +
BoxInterface $size -
string $filter -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -342,52 +422,54 @@

Exceptions

-

-
at line 74
- public ManipulatorInterface - rotate(integer $angle, ColorInterface $background = null) +

+
+

+
at line 97
+ $this + rotate(int $angle, ColorInterface $background = null) +

-

Rotates an image at the given angle.

-

Optional $background can be used to specify the fill color of the empty -area of rotated image.

-
+ + + +
+

Rotates an image at the given angle.

Optional $background can be used to specify the fill color of the empty +area of rotated image.

+

Parameters

- +
- + - + - +
integerint $angle -
ColorInterface $background -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -395,61 +477,64 @@

Exceptions

-

-
at line 92
- public ManipulatorInterface - paste(ImageInterface $image, PointInterface $start) +

+
+

+
at line 115
+ $this + paste(ImageInterface $image, PointInterface $start, int $alpha = 100) +

-

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

-

Returns source image

-
+ + + +
+

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

Returns source image

+

Parameters

- +
- + - + + + + + +
ImageInterface $image -
PointInterface $start -
int$alphaHow to paste the image, from 0 (fully transparent) to 100 (fully opaque)

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - - - - - + + - - + +
InvalidArgumentException -
OutOfBoundsException -InvalidArgumentException
RuntimeException -RuntimeException
@@ -457,52 +542,55 @@

Exceptions

-

-
at line 106
- public ManipulatorInterface - save(string $path = null, array $options = array()) +

+
+

+
at line 130
+ $this + save(string $path = null, array $options = array()) +

-

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

-

-

-
+ + + +
+

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

Please remark that bmp is supported by the GD driver only since PHP 7.2.

+

Parameters

- +
- + - +
string $path -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -510,52 +598,53 @@

Exceptions

-

-
at line 118
- public ManipulatorInterface - show(string $format, array $options = array()) +

+
+

+
at line 142
+ $this + show(string $format, array $options = array()) +

-

Outputs the image content

-

-

-
+ + + +
+

Outputs the image content.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -563,35 +652,38 @@

Exceptions

-

-
at line 127
- public ManipulatorInterface - flipHorizontally() +

+
+

+
at line 151
+ $this + flipHorizontally() +

-

Flips current image using horizontal axis

-

-

-
+ + + +
+

Flips current image using vertical axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -599,35 +691,38 @@

Exceptions

-

-
at line 136
- public ManipulatorInterface - flipVertically() +

+
+

+
at line 160
+ $this + flipVertically() +

-

Flips current image using vertical axis

-

-

-
+ + + +
+

Flips current image using horizontal axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -635,35 +730,38 @@

Exceptions

-

-
at line 145
- public ManipulatorInterface - strip() +

+
+

+
at line 169
+ $this + strip() +

-

Remove all profiles and comments

-

-

-
+ + + +
+

Remove all profiles and comments.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -671,30 +769,34 @@

Exceptions

-

-
at line 159
- public ManipulatorInterface - thumbnail(BoxInterface $size, string $mode = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
at line 183
+ ManipulatorInterface + thumbnail(BoxInterface $size, int|string $settings = self::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

-

-

-
+ + + +
+

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+

Parameters

- +
- + - - - + + + @@ -706,22 +808,20 @@

Parameters

Return Value

-
BoxInterface $size -
string$mode -int|string$settingsOne or more of the ManipulatorInterface::THUMBNAIL_ flags (joined with |). It may be a string for backward compatibility with old constant values that were strings.
string
+
- +
ManipulatorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -729,35 +829,38 @@

Exceptions

-

-
at line 168
- public ManipulatorInterface - applyMask(ImageInterface $mask) +

+
+

+
at line 192
+ $this + applyMask(ImageInterface $mask) +

-

Applies a given mask to current image's alpha channel

-

-

-
+ + + +
+

Applies a given mask to current image's alpha channel.

+

Parameters

- +
- +
ImageInterface $mask -

Return Value

- +
- - + +
ManipulatorInterface -$this
@@ -766,35 +869,40 @@

Return Value

-

-
at line 179
- public ManipulatorInterface - fill(FillInterface $fill) +

+
+

+
at line 203
+ $this + fill(FillInterface $fill) +

-

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

-

-

-
+ + + +
+

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+

Parameters

- +
- +
FillInterface $fill -

Return Value

- +
- - + +
ManipulatorInterface -$this
@@ -803,10 +911,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Metadata.html b/docs/API/API/Imagine/Image/Metadata.html index 87a56953c..6698de5be 100644 --- a/docs/API/API/Imagine/Image/Metadata.html +++ b/docs/API/API/Imagine/Image/Metadata.html @@ -1,60 +1,144 @@ - - - - Imagine\Image\Metadata | - - - -
- - -
- -
Namespace
-

Imagine\Image\Metadata

+ + + + Imagine\Image\Metadata | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Metadata
  7. \
    8. +
+
+
+ +
+

Imagine\Image\Metadata

-
- - - - - - - - - - - - - - - - - -
AbstractMetadataReader -
DefaultMetadataReaderDefault metadata reader
ExifMetadataReaderMetadata driven by Exif information
MetadataBagAn interface for Image Metadata
+ + +

Classes

+ +
+
+
+ AbstractMetadataReader + +
+
+ Base class for the default metadata readers. +
+
+
+
+ DefaultMetadataReader + +
+
+ A metadata reader that actually doesn't try to extract metadata. +
+
+
+
+ ExifMetadataReader + +
+
+ Metadata driven by Exif information. +
+
+
+
+ MetadataBag + +
+
+ The container of the data extracted from metadata. +
+
+

Interfaces

- - - - - -
MetadataReaderInterface -
+ +
+
+
+ MetadataReaderInterface + +
+
+ Interface that metadata readers must implement. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Metadata/AbstractMetadataReader.html b/docs/API/API/Imagine/Image/Metadata/AbstractMetadataReader.html index 7cdfd5fa5..d81b64962 100644 --- a/docs/API/API/Imagine/Image/Metadata/AbstractMetadataReader.html +++ b/docs/API/API/Imagine/Image/Metadata/AbstractMetadataReader.html @@ -1,203 +1,472 @@ - - - - Imagine\Image\Metadata\AbstractMetadataReader | - - - -
- - -
- -
Class
-

Imagine\Image\Metadata\AbstractMetadataReader

+ + + + Imagine\Image\Metadata\AbstractMetadataReader | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Metadata
  7. \
  8. AbstractMetadataReader
    9. +
+
+
+ +
+

+ AbstractMetadataReader + +

-
-

abstract class + +

abstract class AbstractMetadataReader implements - MetadataReaderInterface

+ MetadataReaderInterface +

+ + + +
+

Base class for the default metadata readers.

+

Methods

- - - - - - - - - - - - - - - - -
+
+
+
MetadataBag -
- readFile($file $file) -

Reads metadata from a file.

-
+ +
+ readFile(string|LoaderInterface $file) + +

Reads metadata from a file.

+
+ +
+
MetadataBag -
- readData($data $data) -

Reads metadata from a binary string.

-
+ +
+ readData(string $data, resource $originalResource = null) + +

Reads metadata from a binary string.

+
+ +
+
MetadataBag -
- readStream($resource $resource) -

Reads metadata from a stream.

-
+
+
+ readStream(resource $resource) + +

Reads metadata from a stream.

+
+
+
+
+ array +
+
+ extractFromFile(string|LoaderInterface $file) + +

Extracts metadata from a file.

+
+
+
+
+ array +
+
+ extractFromData($data) + +

Extracts metadata from raw data.

+
+
+
+
+ array +
+
+ extractFromStream($resource) + +

Extracts metadata from a stream.

+
+
+

Details

-

-
at line 21
- public MetadataBag - readFile($file $file) +
+
+

+
at line 28
+ MetadataBag + readFile(string|LoaderInterface $file) +

-

Reads metadata from a file.

-

-

-
+ + + +
+

Reads metadata from a file.

+

Parameters

- +
- + - +
$filestring|LoaderInterface $fileThe path to the file where to read metadata.the path to the file where to read metadata

Return Value

- +
- +
MetadataBag -

Exceptions

- +
- - + +
InvalidArgumentExceptionIn case the file does not exist.InvalidArgumentExceptionin case the file does not exist
+

See also

+ + + + + + +
+ MetadataReaderInterface::readFile +
+
-

-
at line 37
- public MetadataBag - readData($data $data) +

+
+

+
at line 40
+ MetadataBag + readData(string $data, resource $originalResource = null) +

-

Reads metadata from a binary string.

-

-

-
+ + + +
+

Reads metadata from a binary string.

+

Parameters

- +
- + - + + + + + +
$datastring $dataThe binary string to read.the binary string to read
resource$originalResourcean optional resource to gather stream metadata

Return Value

- +
- +
MetadataBag -
+

See also

+ + + + + + +
+ MetadataReaderInterface::readData +
+
-

-
at line 45
- public MetadataBag - readStream($resource $resource) +

+
+

+
at line 54
+ MetadataBag + readStream(resource $resource) +

-

Reads metadata from a stream.

-

-

-
+ + + +
+

Reads metadata from a stream.

+

Parameters

- +
- + - +
$resourceresource $resourceThe stream to read.the stream to read

Return Value

- +
- +
MetadataBag -

Exceptions

- +
+ + + + +
InvalidArgumentExceptionin case the resource is not valid
+ + +

See also

+ + + + + + +
+ MetadataReaderInterface::readStream +
+ +
+
+ +
+
+

+
at line 98
+ abstract protected array + extractFromFile(string|LoaderInterface $file) + +

+
+ + + +
+

Extracts metadata from a file.

+
+

Parameters

+ + + + + + + +
string|LoaderInterface$file
+ + +

Return Value

+ + + + + + +
arrayAn associative array of metadata
+ + + +
+
+ +
+
+

+
at line 107
+ abstract protected array + extractFromData($data) + +

+
+ + + +
+

Extracts metadata from raw data.

+
+

Parameters

+ + + + + + + +
$data
+ + +

Return Value

+ + + + + + +
arrayAn associative array of metadata
+ + + +
+
+ +
+
+

+
at line 116
+ abstract protected array + extractFromStream($resource) + +

+
+ + + +
+

Extracts metadata from a stream.

+
+

Parameters

+ + - - + + +
InvalidArgumentExceptionIn case the resource is not valid.$resource
+

Return Value

+ + + + + + +
arrayAn associative array of metadata
+ + +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Metadata/DefaultMetadataReader.html b/docs/API/API/Imagine/Image/Metadata/DefaultMetadataReader.html index b8b3e9def..5a77248d6 100644 --- a/docs/API/API/Imagine/Image/Metadata/DefaultMetadataReader.html +++ b/docs/API/API/Imagine/Image/Metadata/DefaultMetadataReader.html @@ -1,207 +1,504 @@ - - - - Imagine\Image\Metadata\DefaultMetadataReader | - - - -
- - -
- -
Class
-

Imagine\Image\Metadata\DefaultMetadataReader

+ + + + Imagine\Image\Metadata\DefaultMetadataReader | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - DefaultMetadataReader extends AbstractMetadataReader

-
-

Default metadata reader

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Metadata
  7. \
  8. DefaultMetadataReader
    9. +
+
+
+ +
+

+ DefaultMetadataReader + +

+
+ +

class + DefaultMetadataReader extends AbstractMetadataReader +

+ + + + +
+

A metadata reader that actually doesn't try to extract metadata.

+

Methods

- - - - - - - - - - - - - - - - -
+
+
+
MetadataBag -
- readFile($file $file) -

Reads metadata from a file.

- 		from AbstractMetadataReader
+ +
+ readFile(string|LoaderInterface $file) + +

Reads metadata from a file.

+
from AbstractMetadataReader
+ +
+
MetadataBag -
- readData($data $data) -

Reads metadata from a binary string.

- 		from AbstractMetadataReader
+ +
+ readData(string $data, resource $originalResource = null) + +

Reads metadata from a binary string.

+
from AbstractMetadataReader
+ +
+
MetadataBag -
- readStream($resource $resource) -

Reads metadata from a stream.

- 		from AbstractMetadataReader
+
+
+ readStream(resource $resource) + +

Reads metadata from a stream.

+
from AbstractMetadataReader
+
+
+
+ array +
+
+ extractFromFile(string|LoaderInterface $file) + +

Extracts metadata from a file.

+
+
+
+
+ array +
+
+ extractFromData($data) + +

Extracts metadata from raw data.

+
+
+
+
+ array +
+
+ extractFromStream($resource) + +

Extracts metadata from a stream.

+
+
+

Details

-

-
in AbstractMetadataReader at line 21
- public MetadataBag - readFile($file $file) +
+
+

+
in AbstractMetadataReader at line 28
+ MetadataBag + readFile(string|LoaderInterface $file) +

-

Reads metadata from a file.

-

-

-
+ + + +
+

Reads metadata from a file.

+

Parameters

- +
- + - +
$filestring|LoaderInterface $fileThe path to the file where to read metadata.the path to the file where to read metadata

Return Value

- +
- +
MetadataBag -

Exceptions

- +
- - + +
InvalidArgumentExceptionIn case the file does not exist.InvalidArgumentExceptionin case the file does not exist
+

See also

+ + + + + + +
+ MetadataReaderInterface::readFile +
+
-

-
in AbstractMetadataReader at line 37
- public MetadataBag - readData($data $data) +

+
+

+
in AbstractMetadataReader at line 40
+ MetadataBag + readData(string $data, resource $originalResource = null) +

-

Reads metadata from a binary string.

-

-

-
+ + + +
+

Reads metadata from a binary string.

+

Parameters

- +
- + - + + + + + +
$datastring $dataThe binary string to read.the binary string to read
resource$originalResourcean optional resource to gather stream metadata

Return Value

- +
- +
MetadataBag -
+

See also

+ + + + + + +
+ MetadataReaderInterface::readData +
+
-

-
in AbstractMetadataReader at line 45
- public MetadataBag - readStream($resource $resource) +

+
+

+
in AbstractMetadataReader at line 54
+ MetadataBag + readStream(resource $resource) +

-

Reads metadata from a stream.

-

-

-
+ + + +
+

Reads metadata from a stream.

+

Parameters

- +
- + - +
$resourceresource $resourceThe stream to read.the stream to read

Return Value

- +
- +
MetadataBag -

Exceptions

- +
+ + + + +
InvalidArgumentExceptionin case the resource is not valid
+ + +

See also

+ + + + + + +
+ MetadataReaderInterface::readStream +
+ +
+
+ +
+
+

+
at line 24
+ protected array + extractFromFile(string|LoaderInterface $file) + +

+
+ + + +
+

Extracts metadata from a file.

+
+

Parameters

+ + - - + + +
InvalidArgumentExceptionIn case the resource is not valid.string|LoaderInterface$file
+

Return Value

+ + + + + + +
arrayAn associative array of metadata
+ + + +

See also

+ + + + + + +
+ AbstractMetadataReader::extractFromFile +
+
+
+
+

+
at line 34
+ protected array + extractFromData($data) + +

+
+ + + +
+

Extracts metadata from raw data.

+
+

Parameters

+ + + + + + + +
$data
+ + +

Return Value

+ + + + + + +
arrayAn associative array of metadata
+ + + +

See also

+ + + + + + +
+ AbstractMetadataReader::extractFromData +
+ +
+
+ +
+
+

+
at line 44
+ protected array + extractFromStream($resource) + +

+
+ + + +
+

Extracts metadata from a stream.

+
+

Parameters

+ + + + + + + +
$resource
+ + +

Return Value

+ + + + + + +
arrayAn associative array of metadata
+ + + +

See also

+ + + + + + +
+ AbstractMetadataReader::extractFromStream +
+ +
+
+ +
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Metadata/ExifMetadataReader.html b/docs/API/API/Imagine/Image/Metadata/ExifMetadataReader.html index d19bb702f..bb6c56362 100644 --- a/docs/API/API/Imagine/Image/Metadata/ExifMetadataReader.html +++ b/docs/API/API/Imagine/Image/Metadata/ExifMetadataReader.html @@ -1,235 +1,623 @@ - - - - Imagine\Image\Metadata\ExifMetadataReader | - - - -
- - -
- -
Class
-

Imagine\Image\Metadata\ExifMetadataReader

+ + + + Imagine\Image\Metadata\ExifMetadataReader | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - ExifMetadataReader extends AbstractMetadataReader

-
-

Metadata driven by Exif information

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Metadata
  7. \
  8. ExifMetadataReader
    9. +
+
+
+ +
+

+ ExifMetadataReader + +

+
+ +

class + ExifMetadataReader extends AbstractMetadataReader +

+ + + + +
+

Metadata driven by Exif information.

+

Methods

- - - - - - - - - - - - - - - - - - - - - -
+
+
+
MetadataBag -
- readFile($file $file) -

Reads metadata from a file.

- 		from AbstractMetadataReader
+ +
+ readFile(string|LoaderInterface $file) + +

Reads metadata from a file.

+
from AbstractMetadataReader
+ +
+
MetadataBag -
- readData($data $data) -

Reads metadata from a binary string.

- 		from AbstractMetadataReader
+ +
+ readData(string $data, resource $originalResource = null) + +

Reads metadata from a binary string.

+
from AbstractMetadataReader
+ +
+
MetadataBag -
- readStream($resource $resource) -

Reads metadata from a stream.

- 		from AbstractMetadataReader
+ +
+ readStream(resource $resource) + +

Reads metadata from a stream.

+
from AbstractMetadataReader
+ +
+
+ array +
+
+ extractFromFile(string|LoaderInterface $file) + +

Extracts metadata from a file.

+
+
+
+
+ array +
+
+ extractFromData($data) + +

Extracts metadata from raw data.

+
+
+
+
+ array +
+
+ extractFromStream($resource) + +

Extracts metadata from a stream.

+
+
+
+
-
+ +
__construct() -

-

-
+ +

No description

+
+
+
+
+
+ static string +
+
+ getUnsupportedReason() + +

Get the reason why this metadata reader is not supported.

+
+
+
+
+ static bool +
+
+ isSupported() + +

Is this metadata reader supported?

+
+
+

Details

-

-
in AbstractMetadataReader at line 21
- public MetadataBag - readFile($file $file) +
+
+

+
in AbstractMetadataReader at line 28
+ MetadataBag + readFile(string|LoaderInterface $file) +

-

Reads metadata from a file.

-

-

-
+ + + +
+

Reads metadata from a file.

+

Parameters

- +
- + - +
$filestring|LoaderInterface $fileThe path to the file where to read metadata.the path to the file where to read metadata

Return Value

- +
- +
MetadataBag -

Exceptions

- +
- - + +
InvalidArgumentExceptionIn case the file does not exist.InvalidArgumentExceptionin case the file does not exist
+

See also

+ + + + + + +
+ MetadataReaderInterface::readFile +
+
-

-
in AbstractMetadataReader at line 37
- public MetadataBag - readData($data $data) +

+
+

+
in AbstractMetadataReader at line 40
+ MetadataBag + readData(string $data, resource $originalResource = null) +

-

Reads metadata from a binary string.

-

-

-
+ + + +
+

Reads metadata from a binary string.

+

Parameters

- +
- + - + + + + + +
$datastring $dataThe binary string to read.the binary string to read
resource$originalResourcean optional resource to gather stream metadata

Return Value

- +
- +
MetadataBag -
+

See also

+ + + + + + +
+ MetadataReaderInterface::readData +
+
-

-
in AbstractMetadataReader at line 45
- public MetadataBag - readStream($resource $resource) +

+
+

+
in AbstractMetadataReader at line 54
+ MetadataBag + readStream(resource $resource) +

-

Reads metadata from a stream.

-

-

-
+ + + +
+

Reads metadata from a stream.

+

Parameters

- +
- + - +
$resourceresource $resourceThe stream to read.the stream to read

Return Value

- +
- +
MetadataBag -

Exceptions

- +
- - + +
InvalidArgumentExceptionIn case the resource is not valid.InvalidArgumentExceptionin case the resource is not valid
+

See also

+ + + + + + +
+ MetadataReaderInterface::readStream +
+
-

-
at line 22
- public - __construct() +

+
+

+
at line 70
+ protected array + extractFromFile(string|LoaderInterface $file) +

-

-

-

-

-
+ + +
+

Extracts metadata from a file.

+
+

Parameters

+ + + + + + + +
string|LoaderInterface$file
+ + +

Return Value

+ + + + + + +
arrayAn associative array of metadata
+ +

See also

+ + + + + + +
+ AbstractMetadataReader::extractFromFile +
+
+
+
+

+
at line 86
+ protected array + extractFromData($data) + +

+
+ + +
+

Extracts metadata from raw data.

+
+

Parameters

+ + + + + + + +
$data
+ + +

Return Value

+ + + + + + +
arrayAn associative array of metadata
+ + + +

See also

+ + + + + + +
+ AbstractMetadataReader::extractFromData +
+ +
+
+ +
+
+

+
at line 96
+ protected array + extractFromStream($resource) + +

+
+ + + +
+

Extracts metadata from a stream.

+
+

Parameters

+ + + + + + + +
$resource
+ + +

Return Value

+ + + + + + +
arrayAn associative array of metadata
+ + + +

See also

+ + + + + + +
+ AbstractMetadataReader::extractFromStream +
+ +
+
+ +
+
+

+
at line 27
+ + __construct() + +

+
+ + + +
+ + +

Exceptions

+ + + + + + +
NotSupportedException
+ + +
+
+
- + + +
+ + +
+ diff --git a/docs/API/API/Imagine/Image/Metadata/MetadataBag.html b/docs/API/API/Imagine/Image/Metadata/MetadataBag.html index a8a4c58ba..fcc890bfc 100644 --- a/docs/API/API/Imagine/Image/Metadata/MetadataBag.html +++ b/docs/API/API/Imagine/Image/Metadata/MetadataBag.html @@ -1,138 +1,216 @@ - - - - Imagine\Image\Metadata\MetadataBag | - - - -
- - -
- -
Class
-

Imagine\Image\Metadata\MetadataBag

+ + + + Imagine\Image\Metadata\MetadataBag | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Metadata
  7. \
  8. MetadataBag
    9. +
+
+
+ +
+

+ MetadataBag + +

-
-

class + +

class MetadataBag implements - ArrayAccess, IteratorAggregate

+ ArrayAccess, IteratorAggregate, Countable +

+ + +
-

An interface for Image Metadata

-

-

-
+

The container of the data extracted from metadata.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
+ +
__construct(array $data = array()) -

-

-
+ +

No description

+ +
+ +
+
+ mixed +
+
+ get(string $key, mixed|null $default = null) + +

Returns the metadata key, default value if it does not exist.

+
+
+
+
-
+ +
+ count() + +

{@inheritdoc}

+
+ +
+
+ +
+
getIterator() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetExists($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetSet($offset, $value) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetUnset($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetGet($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
array -
+ +
toArray() -

Returns metadata as an array

-
+ +

Returns metadata as an associative array.

+
+
+

Details

-

-
at line 22
- public - __construct(array $data = array()) +
+
+

+
at line 27
+ + __construct(array $data = array()) +

-

-

-

-

-
+ + + +

Parameters

- +
- +
array $data -
@@ -142,153 +220,310 @@

Parameters

-

-
at line 30
- public - getIterator() +

+
+

+
at line 40
+ mixed + get(string $key, mixed|null $default = null) +

-

{@inheritdoc}

-

-

-
+ + +
+

Returns the metadata key, default value if it does not exist.

+
+

Parameters

+ + + + + + + + + + + + +
string$key
mixed|null$default
+ + +

Return Value

+ + + + + + +
mixed
+
-

-
at line 38
- public - offsetExists($offset) +

+
+

+
at line 50
+ + count() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+ + + +

See also

+ + + + + + +
+ \Countable::count() +
+ +
+
+ +
+
+

+
at line 60
+ + getIterator() + +

+
+ + + +
+

{@inheritdoc}

+
+ + + +

See also

+ + + + + + +
+ \IteratorAggregate::getIterator() +
+ +
+
+ +
+
+

+
at line 70
+ + offsetExists($offset) + +

+
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetExists() +
+
-

-
at line 46
- public - offsetSet($offset, $value) +

+
+

+
at line 80
+ + offsetSet($offset, $value) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- + - +
$offset -
$value -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetSet() +
+
-

-
at line 54
- public - offsetUnset($offset) +

+
+

+
at line 90
+ + offsetUnset($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetUnset() +
+
-

-
at line 62
- public - offsetGet($offset) +

+
+

+
at line 100
+ + offsetGet($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetGet() +
+
-

-
at line 72
- public array - toArray() +

+
+

+
at line 110
+ array + toArray() +

-

Returns metadata as an array

-

-

-
+ + + +
+

Returns metadata as an associative array.

+

Return Value

- +
- +
arrayAn associative array
@@ -297,10 +532,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Metadata/MetadataReaderInterface.html b/docs/API/API/Imagine/Image/Metadata/MetadataReaderInterface.html index fd66cd7e1..5e8f40075 100644 --- a/docs/API/API/Imagine/Image/Metadata/MetadataReaderInterface.html +++ b/docs/API/API/Imagine/Image/Metadata/MetadataReaderInterface.html @@ -1,110 +1,176 @@ - - - - Imagine\Image\Metadata\MetadataReaderInterface | - - - -
- + + + + Imagine\Image\Metadata\MetadataReaderInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
-
+
-
Interface
-

Imagine\Image\Metadata\MetadataReaderInterface

+
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Metadata
  7. \
  8. MetadataReaderInterface
    9. +
+
+
+ +
+

+ MetadataReaderInterface + +

-
-

interface - MetadataReaderInterface

+

interface + MetadataReaderInterface +

+ + + + +
+

Interface that metadata readers must implement.

+

Methods

- - - - - - - - - - - - - - - - -
+
+
+
MetadataBag -
- readFile($file $file) -

Reads metadata from a file.

-
+ +
+ readFile(string|LoaderInterface $file) + +

Reads metadata from a file.

+
+ +
+
MetadataBag -
- readData($data $data) -

Reads metadata from a binary string.

-
+ +
+ readData(string $data, resource $originalResource = null) + +

Reads metadata from a binary string.

+
+ +
+
MetadataBag -
- readStream($resource $resource) -

Reads metadata from a stream.

-
+
+
+ readStream(resource $resource) + +

Reads metadata from a stream.

+
+
+

Details

-

-
at line 27
- public MetadataBag - readFile($file $file) +
+
+

+
at line 28
+ MetadataBag + readFile(string|LoaderInterface $file) +

-

Reads metadata from a file.

-

-

-
+ + + +
+

Reads metadata from a file.

+

Parameters

- +
- + - +
$filestring|LoaderInterface $fileThe path to the file where to read metadata.the path to the file where to read metadata

Return Value

- +
- +
MetadataBag -

Exceptions

- +
- - + +
InvalidArgumentExceptionIn case the file does not exist.InvalidArgumentExceptionin case the file does not exist
@@ -112,34 +178,43 @@

Exceptions

-

-
at line 36
- public MetadataBag - readData($data $data) +

+
+

+
at line 38
+ MetadataBag + readData(string $data, resource $originalResource = null) +

-

Reads metadata from a binary string.

-

-

-
+ + + +
+

Reads metadata from a binary string.

+

Parameters

- +
- + - + + + + + +
$datastring $dataThe binary string to read.the binary string to read
resource$originalResourcean optional resource to gather stream metadata

Return Value

- +
- +
MetadataBag -
@@ -148,44 +223,48 @@

Return Value

-

-
at line 47
- public MetadataBag - readStream($resource $resource) +

+
+

+
at line 49
+ MetadataBag + readStream(resource $resource) +

-

Reads metadata from a stream.

-

-

-
+ + + +
+

Reads metadata from a stream.

+

Parameters

- +
- + - +
$resourceresource $resourceThe stream to read.the stream to read

Return Value

- +
- +
MetadataBag -

Exceptions

- +
- - + +
InvalidArgumentExceptionIn case the resource is not valid.InvalidArgumentExceptionin case the resource is not valid
@@ -193,10 +272,17 @@

Exceptions

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Metadata/namespace-frame.html b/docs/API/API/Imagine/Image/Metadata/namespace-frame.html deleted file mode 100644 index 4ea05d078..000000000 --- a/docs/API/API/Imagine/Image/Metadata/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Image\Metadata | - - - diff --git a/docs/API/API/Imagine/Image/Palette.html b/docs/API/API/Imagine/Image/Palette.html index ca6188b67..41b12f3f2 100644 --- a/docs/API/API/Imagine/Image/Palette.html +++ b/docs/API/API/Imagine/Image/Palette.html @@ -1,63 +1,147 @@ - - - - Imagine\Image\Palette | - - - -
- - -
- -
Namespace
-

Imagine\Image\Palette

+ + + + Imagine\Image\Palette | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
    8. +
+
+
+ +
+

Imagine\Image\Palette

-
- - - - - - - - - - - - - - - - - -
CMYK -
ColorParser -
Grayscale -
RGB -
+ +

Namespaces

+
+ Imagine\Image\Palette\Color
+ +

Classes

+ +
+
+
+ CMYK + +
+
+ The CMYK palette. +
+
+
+
+ ColorParser + +
+
+ +
+
+
+
+ Grayscale + +
+
+ The grayscale palette. +
+
+
+
+ RGB + +
+
+ The RGB palette. +
+
+

Interfaces

- - - - - -
PaletteInterface -
+ +
+
+
+ PaletteInterface + +
+
+ Interface that any palette must implement. +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/CMYK.html b/docs/API/API/Imagine/Image/Palette/CMYK.html index 59193e301..01e69d787 100644 --- a/docs/API/API/Imagine/Image/Palette/CMYK.html +++ b/docs/API/API/Imagine/Image/Palette/CMYK.html @@ -1,239 +1,406 @@ - - - - Imagine\Image\Palette\CMYK | - - - -
- - -
- -
Class
-

Imagine\Image\Palette\CMYK

+ + + + Imagine\Image\Palette\CMYK | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. CMYK
    9. +
+
+
+ +
+

+ CMYK + +

-
-

class + +

class CMYK implements - PaletteInterface

+ PaletteInterface +

+ + + +
+

The CMYK palette.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
+ +
__construct() -

-

-
- String - + +

No description

+ +
+ +
+
+ string +
+
name() -

Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants

-
- array - + +

Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.

+
+ +
+
+ string[] +
+
pixelDefinition() -

Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.

-
- Boolean - + +

Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.

+
+ +
+
+ bool +
+
supportsAlpha() -

Tells if alpha channel is supported in this palette

-
+ +

Tells if alpha channel is supported in this palette.

+
+ +
+
+ int +
+
+ getChannelsMaxValue() + +

Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).

+
+
+
+
ColorInterface -
- color(string|array|integer $color, integer|null $alpha = null) -

Returns a color given some values

-
+ +
+ color(string|int[]|int $color, int|null $alpha = null) + +

Returns a color given some values.

+
+ +
+
ColorInterface -
+ +
blend(ColorInterface $color1, ColorInterface $color2, float $amount) -

Blend two colors given an amount

-
- PaletteInterface - + +

Blend two colors given an amount.

+
+ +
+
+ $this +
+
useProfile(ProfileInterface $profile) -

Attachs an ICC profile to this Palette.

-
+ +

Attachs an ICC profile to this Palette.

+
+ +
+
ProfileInterface -
+ +
profile() -

Returns the ICC profile attached to this Palette.

-
+ +

Returns the ICC profile attached to this Palette.

+
+
+

Details

-

-
at line 27
- public - __construct() +
+
+

+
at line 41
+ + __construct() +

-

-

-

-

-
+ + + +
-

-
at line 35
- public String - name() +

+
+

+
at line 51
+ string + name() +

-

Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants

-

-

-
+ + + +
+

Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.

+

Return Value

- +
- - + +
String -string
+

See also

+ + + + + + +
+ PaletteInterface::name +
+
-

-
at line 43
- public array - pixelDefinition() +

+
+

+
at line 61
+ string[] + pixelDefinition() +

-

Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.

-

-

-
+ + + +
+

Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.

+

Return Value

- +
- - + +
array -string[]
+

See also

+ + + + + + +
+ PaletteInterface::pixelDefinition +
+
-

-
at line 56
- public Boolean - supportsAlpha() +

+
+

+
at line 76
+ bool + supportsAlpha() + +

+
+ + + +
+

Tells if alpha channel is supported in this palette.

+
+ +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + + + +
+ PaletteInterface::supportsAlpha +
+ +
+
+ +
+
+

+
at line 86
+ int + getChannelsMaxValue() +

-

Tells if alpha channel is supported in this palette

-

-

-
+ + + +
+

Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).

+

Return Value

- +
- - + +
Boolean -int
+

See also

+ + + + + + +
+ PaletteInterface::getChannelsMaxValue +
+
-

-
at line 64
- public ColorInterface - color(string|array|integer $color, integer|null $alpha = null) +

+
+

+
at line 96
+ ColorInterface + color(string|int[]|int $color, int|null $alpha = null) +

-

Returns a color given some values

-

-

-
+ + + +
+

Returns a color given some values.

+

Parameters

- +
- + - + @@ -242,52 +409,65 @@

Parameters

Return Value

-
string|array|integerstring|int[]|int $color A color
integer|nullint|null $alpha Set alpha to null to disable it
+
- +
ColorInterface -

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException In case you pass an alpha value to a Palette that does not support alpha
+

See also

+ + + + + + +
+ PaletteInterface::color +
+
-

-
at line 83
- public ColorInterface - blend(ColorInterface $color1, ColorInterface $color2, float $amount) +

+
+

+
at line 117
+ ColorInterface + blend(ColorInterface $color1, ColorInterface $color2, float $amount) +

-

Blend two colors given an amount

-

-

-
+ + + +
+

Blend two colors given an amount.

+

Parameters

- +
- + - + @@ -299,85 +479,132 @@

Parameters

Return Value

-
ColorInterface $color1 -
ColorInterface $color2 -
float
+
- +
ColorInterface -
+

See also

+ + + + + + +
+ PaletteInterface::blend +
+
-

-
at line 100
- public PaletteInterface - useProfile(ProfileInterface $profile) +

+
+

+
at line 137
+ $this + useProfile(ProfileInterface $profile) +

-

Attachs an ICC profile to this Palette.

-

(A default profile is provided by default)

-
+ + + +
+

Attachs an ICC profile to this Palette.

(A default profile is provided by default)

+

Parameters

- +
- +
ProfileInterface $profile -

Return Value

- +
- - + +
PaletteInterface -$this
+

See also

+ + + + + + +
+ PaletteInterface::useProfile +
+
-

-
at line 110
- public ProfileInterface - profile() +

+
+

+
at line 149
+ ProfileInterface + profile() +

-

Returns the ICC profile attached to this Palette.

-

-

-
+ + + +
+

Returns the ICC profile attached to this Palette.

+

Return Value

- +
- +
ProfileInterface -
+

See also

+ + + + + + +
+ PaletteInterface::profile +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/Color.html b/docs/API/API/Imagine/Image/Palette/Color.html index da22a238b..13d284b97 100644 --- a/docs/API/API/Imagine/Image/Palette/Color.html +++ b/docs/API/API/Imagine/Image/Palette/Color.html @@ -1,58 +1,135 @@ - - - - Imagine\Image\Palette\Color | - - - -
- - -
- -
Namespace
-

Imagine\Image\Palette\Color

+ + + + Imagine\Image\Palette\Color | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. Color
  9. \
    10. +
+
+
+ +
+

Imagine\Image\Palette\Color

-
- - - - - - - - - - - - - -
CMYK -
Gray -
RGB -
+ + +

Classes

+ +
+
+
+ CMYK + +
+
+ +
+
+
+
+ Gray + +
+
+ +
+
+
+
+ RGB + +
+
+ +
+
+

Interfaces

- - - - - -
ColorInterface -
+ +
+
+
+ ColorInterface + +
+
+ +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/Color/CMYK.html b/docs/API/API/Imagine/Image/Palette/Color/CMYK.html index 682752498..7411ee448 100644 --- a/docs/API/API/Imagine/Image/Palette/Color/CMYK.html +++ b/docs/API/API/Imagine/Image/Palette/Color/CMYK.html @@ -1,209 +1,269 @@ - - - - Imagine\Image\Palette\Color\CMYK | - - - -
- - -
- -
Class
-

Imagine\Image\Palette\Color\CMYK

+ + + + Imagine\Image\Palette\Color\CMYK | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. Color
  9. \
  10. CMYK
    11. +
+
+
+ +
+

+ CMYK + +

-
-

class + +

class CMYK implements - ColorInterface

+ ColorInterface +

+ + + +

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
+ +
__construct(CMYK $palette, array $color) -

-

-
- Integer - + +

No description

+ +
+ +
+
+ int|null +
+
getValue(string $component) -

Return the value of one of the component.

-
- integer - + +

Return the value of one of the component.

+
+ +
+
+ int +
+
getCyan() -

Returns Cyan value of the color

-
- integer - + +

Returns Cyan value of the color (from 0 to 100).

+
+ +
+
+ int +
+
getMagenta() -

Returns Magenta value of the color

-
- integer - + +

Returns Magenta value of the color (from 0 to 100).

+
+ +
+
+ int +
+
getYellow() -

Returns Yellow value of the color

-
- integer - + +

Returns Yellow value of the color (from 0 to 100).

+
+ +
+
+ int +
+
getKeyline() -

Returns Key value of the color

-
+ +

Returns Key value of the color (from 0 to 100).

+
+ +
+
PaletteInterface -
+ +
getPalette() -

Returns the palette attached to the current color

-
- integer - + +

Returns the palette attached to the current color.

+
+ +
+
+ int|null +
+
getAlpha() -

Returns percentage of transparency of the color

-
+ +

Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).

+
+ +
+
ColorInterface -
- dissolve(integer $alpha) -

Returns a copy of current color, incrementing the alpha channel by the given amount

-
+ +
+ dissolve(int $alpha) + +

Returns a copy of current color, incrementing the alpha channel by the given amount.

+
+ +
+
ColorInterface -
- lighten(integer $shade) -

Returns a copy of the current color, lightened by the specified number of shades

-
+ +
+ lighten(int $shade) + +

Returns a copy of the current color, lightened by the specified number of shades.

+
+ +
+
ColorInterface -
- darken(integer $shade) -

Returns a copy of the current color, darkened by the specified number of shades

-
+ +
+ darken(int $shade) + +

Returns a copy of the current color, darkened by the specified number of shades.

+
+ +
+
ColorInterface -
+ +
grayscale() -

Returns a gray related to the current color

-
- Boolean - + +

Returns a gray related to the current color.

+
+ +
+
+ bool +
+
isOpaque() -

Checks if the current color is opaque

-
+ +

Checks if the current color is opaque.

+
+ +
+
string -
+ +
__toString() -

Returns hex representation of the color

-
+ +

Returns hex representation of the color.

+
+
+

Details

-

-
at line 46
- public - __construct(CMYK $palette, array $color) +
+
+

+
at line 49
+ + __construct(CMYK $palette, array $color) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - +
CMYK $palette -
array $color -
@@ -213,19 +273,24 @@

Parameters

-

-
at line 55
- public Integer - getValue(string $component) +

+
+

+
at line 60
+ int|null + getValue(string $component) +

-

Return the value of one of the component.

-

-

-
+ + + +
+

Return the value of one of the component.

+

Parameters

- +
@@ -236,37 +301,60 @@

Parameters

Return Value

-
string $component
+
- - + +
Integer -int|null
+

Exceptions

+ + + + + + +
InvalidArgumentExceptionif $component is not valid
+ +

See also

+ + + + + + +
+ ColorInterface::getValue +
+
-

-
at line 76
- public integer - getCyan() +

+
+

+
at line 81
+ int + getCyan() +

-

Returns Cyan value of the color

-

-

-
+ + + +
+

Returns Cyan value of the color (from 0 to 100).

+

Return Value

- +
- - + +
integer -int
@@ -275,24 +363,28 @@

Return Value

-

-
at line 86
- public integer - getMagenta() +

+
+

+
at line 91
+ int + getMagenta() +

-

Returns Magenta value of the color

-

-

-
+ + + +
+

Returns Magenta value of the color (from 0 to 100).

+

Return Value

- +
- - + +
integer -int
@@ -301,24 +393,28 @@

Return Value

-

-
at line 96
- public integer - getYellow() +

+
+

+
at line 101
+ int + getYellow() +

-

Returns Yellow value of the color

-

-

-
+ + + +
+

Returns Yellow value of the color (from 0 to 100).

+

Return Value

- +
- - + +
integer -int
@@ -327,24 +423,28 @@

Return Value

-

-
at line 106
- public integer - getKeyline() +

+
+

+
at line 111
+ int + getKeyline() +

-

Returns Key value of the color

-

-

-
+ + + +
+

Returns Key value of the color (from 0 to 100).

+

Return Value

- +
- - + +
integer -int
@@ -353,251 +453,384 @@

Return Value

-

-
at line 114
- public PaletteInterface - getPalette() +

+
+

+
at line 121
+ PaletteInterface + getPalette() +

-

Returns the palette attached to the current color

-

-

-
+ + + +
+

Returns the palette attached to the current color.

+

Return Value

- +
- +
PaletteInterface -
+

See also

+ + + + + + +
+ ColorInterface::getPalette +
+
-

-
at line 122
- public integer - getAlpha() +

+
+

+
at line 131
+ int|null + getAlpha() +

-

Returns percentage of transparency of the color

-

-

-
+ + + +
+

Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).

+

Return Value

- +
- - + +
integer -int|nullreturn NULL if the color type does not support transparency
+

See also

+ + + + + + +
+ ColorInterface::getAlpha +
+
-

-
at line 130
- public ColorInterface - dissolve(integer $alpha) +

+
+

+
at line 141
+ ColorInterface + dissolve(int $alpha) +

-

Returns a copy of current color, incrementing the alpha channel by the given amount

-

-

-
+ + + +
+

Returns a copy of current color, incrementing the alpha channel by the given amount.

+

Parameters

- +
- + - +
integerint $alpha -

Return Value

- +
- +
ColorInterface -
+

Exceptions

+ + + + + + +
RuntimeExceptionif the color type does not support transparency
+ +

See also

+ + + + + + +
+ ColorInterface::dissolve +
+
-

-
at line 138
- public ColorInterface - lighten(integer $shade) +

+
+

+
at line 151
+ ColorInterface + lighten(int $shade) +

-

Returns a copy of the current color, lightened by the specified number of shades

-

-

-
+ + + +
+

Returns a copy of the current color, lightened by the specified number of shades.

+

Parameters

- +
- + - +
integerint $shade -

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ ColorInterface::lighten +
+
-

-
at line 153
- public ColorInterface - darken(integer $shade) +

+
+

+
at line 168
+ ColorInterface + darken(int $shade) +

-

Returns a copy of the current color, darkened by the specified number of shades

-

-

-
+ + + +
+

Returns a copy of the current color, darkened by the specified number of shades.

+

Parameters

- +
- + - +
integerint $shade -

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ ColorInterface::darken +
+
-

-
at line 168
- public ColorInterface - grayscale() +

+
+

+
at line 185
+ ColorInterface + grayscale() +

-

Returns a gray related to the current color

-

-

-
+ + + +
+

Returns a gray related to the current color.

+

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ ColorInterface::grayscale +
+
-

-
at line 184
- public Boolean - isOpaque() +

+
+

+
at line 203
+ bool + isOpaque() +

-

Checks if the current color is opaque

-

-

-
+ + + +
+

Checks if the current color is opaque.

+

Return Value

- +
- - + +
Boolean -bool
+

See also

+ + + + + + +
+ ColorInterface::isOpaque +
+
-

-
at line 194
- public string - __toString() +

+
+

+
at line 213
+ string + __toString() +

-

Returns hex representation of the color

-

-

-
+ + + +
+

Returns hex representation of the color.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ ColorInterface::__toString +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/Color/ColorInterface.html b/docs/API/API/Imagine/Image/Palette/Color/ColorInterface.html index 4f91ca591..c2fbb59e7 100644 --- a/docs/API/API/Imagine/Image/Palette/Color/ColorInterface.html +++ b/docs/API/API/Imagine/Image/Palette/Color/ColorInterface.html @@ -1,105 +1,149 @@ - - - - Imagine\Image\Palette\Color\ColorInterface | - - - -
- - -
- -
Interface
-

Imagine\Image\Palette\Color\ColorInterface

+ + + + Imagine\Image\Palette\Color\ColorInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. Color
  9. \
  10. ColorInterface
    11. +
+
+
+ +
+

+ ColorInterface + +

-
-

interface - ColorInterface

+ +

interface + ColorInterface +

+ + + +

Constants

- +
COLOR_RED -

-

-

-

+

Channel name: red.

+

COLOR_GREEN -

-

-

-

+

Channel name: green.

+

COLOR_BLUE -

-

-

-

+

Channel name: blue.

+

COLOR_CYAN -

-

-

-

+

Channel name: cyan.

+

COLOR_MAGENTA -

-

-

-

+

Channel name: magenta.

+

COLOR_YELLOW -

-

-

-

+

Channel name: yellow.

+

COLOR_KEYLINE -

-

-

-

+

Channel name: key (black).

+

COLOR_GRAY -

-

-

-

+

Channel name: gray.

+

@@ -108,105 +152,120 @@

Constants

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Integer - +
+
+
+ int|null +
+
getValue(string $component) -

Return the value of one of the component.

-
- integer - + +

Return the value of one of the component.

+
+ +
+
+ int|null +
+
getAlpha() -

Returns percentage of transparency of the color

-
+ +

Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).

+
+ +
+
PaletteInterface -
+ +
getPalette() -

Returns the palette attached to the current color

-
+ +

Returns the palette attached to the current color.

+
+ +
+
ColorInterface -
- dissolve(integer $alpha) -

Returns a copy of current color, incrementing the alpha channel by the given amount

-
+ +
+ dissolve(int $alpha) + +

Returns a copy of current color, incrementing the alpha channel by the given amount.

+
+ +
+
ColorInterface -
- lighten(integer $shade) -

Returns a copy of the current color, lightened by the specified number of shades

-
+ +
+ lighten(int $shade) + +

Returns a copy of the current color, lightened by the specified number of shades.

+
+ +
+
ColorInterface -
- darken(integer $shade) -

Returns a copy of the current color, darkened by the specified number of shades

-
+ +
+ darken(int $shade) + +

Returns a copy of the current color, darkened by the specified number of shades.

+
+ +
+
ColorInterface -
+ +
grayscale() -

Returns a gray related to the current color

-
- Boolean - + +

Returns a gray related to the current color.

+
+ +
+
+ bool +
+
isOpaque() -

Checks if the current color is opaque

-
+ +

Checks if the current color is opaque.

+
+
+
+
+ string +
+
+ __toString() + +

Returns hex representation of the color.

+
+
+

Details

-

-
at line 36
- public Integer - getValue(string $component) +
+
+

+
at line 81
+ int|null + getValue(string $component) +

-

Return the value of one of the component.

-

-

-
+ + + +
+

Return the value of one of the component.

+

Parameters

- +
@@ -217,37 +276,49 @@

Parameters

Return Value

-
string $component
+
- - + +
Integer -int|null
+

Exceptions

+ + + + + + +
InvalidArgumentExceptionif $component is not valid
+
-

-
at line 43
- public integer - getAlpha() +

+
+

+
at line 88
+ int|null + getAlpha() +

-

Returns percentage of transparency of the color

-

-

-
+ + + +
+

Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).

+

Return Value

- +
- - + +
integer -int|nullreturn NULL if the color type does not support transparency
@@ -256,24 +327,28 @@

Return Value

-

-
at line 50
- public PaletteInterface - getPalette() +

+
+

+
at line 95
+ PaletteInterface + getPalette() +

-

Returns the palette attached to the current color

-

-

-
+ + + +
+

Returns the palette attached to the current color.

+

Return Value

- +
- +
PaletteInterface -
@@ -282,72 +357,87 @@

Return Value

-

-
at line 60
- public ColorInterface - dissolve(integer $alpha) +

+
+

+
at line 106
+ ColorInterface + dissolve(int $alpha) +

-

Returns a copy of current color, incrementing the alpha channel by the given amount

-

-

-
+ + + +
+

Returns a copy of current color, incrementing the alpha channel by the given amount.

+

Parameters

- +
- + - +
integerint $alpha -

Return Value

- +
- +
ColorInterface -
+

Exceptions

+ + + + + + +
RuntimeExceptionif the color type does not support transparency
+
-

-
at line 70
- public ColorInterface - lighten(integer $shade) +

+
+

+
at line 115
+ ColorInterface + lighten(int $shade) +

-

Returns a copy of the current color, lightened by the specified number of shades

-

-

-
+ + + +
+

Returns a copy of the current color, lightened by the specified number of shades.

+

Parameters

- +
- + - +
integerint $shade -

Return Value

- +
- +
ColorInterface -
@@ -356,35 +446,38 @@

Return Value

-

-
at line 80
- public ColorInterface - darken(integer $shade) +

+
+

+
at line 124
+ ColorInterface + darken(int $shade) +

-

Returns a copy of the current color, darkened by the specified number of shades

-

-

-
+ + + +
+

Returns a copy of the current color, darkened by the specified number of shades.

+

Parameters

- +
- + - +
integerint $shade -

Return Value

- +
- +
ColorInterface -
@@ -393,24 +486,28 @@

Return Value

-

-
at line 87
- public ColorInterface - grayscale() +

+
+

+
at line 131
+ ColorInterface + grayscale() +

-

Returns a gray related to the current color

-

-

-
+ + + +
+

Returns a gray related to the current color.

+

Return Value

- +
- +
ColorInterface -
@@ -419,24 +516,58 @@

Return Value

-

-
at line 94
- public Boolean - isOpaque() +

+
+

+
at line 138
+ bool + isOpaque() + +

+
+ + + +
+

Checks if the current color is opaque.

+
+ +

Return Value

+ + + + + + +
bool
+ + + +
+
+ +
+
+

+
at line 145
+ string + __toString() +

-

Checks if the current color is opaque

-

-

-
+ + + +
+

Returns hex representation of the color.

+

Return Value

- +
- - + +
Boolean -string
@@ -445,10 +576,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/Color/Gray.html b/docs/API/API/Imagine/Image/Palette/Color/Gray.html index 0c9acd85f..ffc9ae453 100644 --- a/docs/API/API/Imagine/Image/Palette/Color/Gray.html +++ b/docs/API/API/Imagine/Image/Palette/Color/Gray.html @@ -1,185 +1,244 @@ - - - - Imagine\Image\Palette\Color\Gray | - - - -
- - -
- -
Class
-

Imagine\Image\Palette\Color\Gray

+ + + + Imagine\Image\Palette\Color\Gray | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. Color
  9. \
  10. Gray
    11. +
+
+
+ +
+

+ Gray + +

+
+ +

class Gray implements - ColorInterface

+ ColorInterface +

+ + + +

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(Grayscale $palette, array $color, $alpha) -

-

-
- Integer - + +
+ __construct(Grayscale $palette, array $color, int $alpha) + +

No description

+
+
+ +
+
+ int|null +
+
getValue(string $component) -

Return the value of one of the component.

-
- integer - + +

Return the value of one of the component.

+
+ +
+
+ int +
+
getGray() -

Returns Gray value of the color

-
+ +

Returns Gray value of the color (from 0 to 255).

+
+ +
+
PaletteInterface -
+ +
getPalette() -

Returns the palette attached to the current color

-
- integer - + +

Returns the palette attached to the current color.

+
+ +
+
+ int|null +
+
getAlpha() -

Returns percentage of transparency of the color

-
+ +

Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).

+
+ +
+
ColorInterface -
- dissolve(integer $alpha) -

Returns a copy of current color, incrementing the alpha channel by the given amount

-
+ +
+ dissolve(int $alpha) + +

Returns a copy of current color, incrementing the alpha channel by the given amount.

+
+ +
+
ColorInterface -
- lighten(integer $shade) -

Returns a copy of the current color, lightened by the specified number of shades

-
+ +
+ lighten(int $shade) + +

Returns a copy of the current color, lightened by the specified number of shades.

+
+ +
+
ColorInterface -
- darken(integer $shade) -

Returns a copy of the current color, darkened by the specified number of shades

-
+ +
+ darken(int $shade) + +

Returns a copy of the current color, darkened by the specified number of shades.

+
+ +
+
ColorInterface -
+ +
grayscale() -

Returns a gray related to the current color

-
- Boolean - + +

Returns a gray related to the current color.

+
+ +
+
+ bool +
+
isOpaque() -

Checks if the current color is opaque

-
+ +

Checks if the current color is opaque.

+
+ +
+
string -
+ +
__toString() -

Returns hex representation of the color

-
+ +

Returns hex representation of the color.

+
+
+

Details

-

-
at line 35
- public - __construct(Grayscale $palette, array $color, $alpha) +
+
+

+
at line 39
+ + __construct(Grayscale $palette, array $color, int $alpha) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - + - + - +
Grayscale $palette -
array $color -
int $alpha -
@@ -189,19 +248,24 @@

Parameters

-

-
at line 45
- public Integer - getValue(string $component) +

+
+

+
at line 51
+ int|null + getValue(string $component) +

-

Return the value of one of the component.

-

-

-
+ + + +
+

Return the value of one of the component.

+

Parameters

- +
@@ -212,37 +276,60 @@

Parameters

Return Value

-
string $component
+
- - + +
Integer -int|null
+

Exceptions

+ + + + + + +
InvalidArgumentExceptionif $component is not valid
+ +

See also

+ + + + + + +
+ ColorInterface::getValue +
+
-

-
at line 60
- public integer - getGray() +

+
+

+
at line 66
+ int + getGray() +

-

Returns Gray value of the color

-

-

-
+ + + +
+

Returns Gray value of the color (from 0 to 255).

+

Return Value

- +
- - + +
integer -int
@@ -251,251 +338,384 @@

Return Value

-

-
at line 68
- public PaletteInterface - getPalette() +

+
+

+
at line 76
+ PaletteInterface + getPalette() +

-

Returns the palette attached to the current color

-

-

-
+ + + +
+

Returns the palette attached to the current color.

+

Return Value

- +
- +
PaletteInterface -
+

See also

+ + + + + + +
+ ColorInterface::getPalette +
+
-

-
at line 76
- public integer - getAlpha() +

+
+

+
at line 86
+ int|null + getAlpha() +

-

Returns percentage of transparency of the color

-

-

-
+ + + +
+

Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).

+

Return Value

- +
- - + +
integer -int|nullreturn NULL if the color type does not support transparency
+

See also

+ + + + + + +
+ ColorInterface::getAlpha +
+
-

-
at line 84
- public ColorInterface - dissolve(integer $alpha) +

+
+

+
at line 96
+ ColorInterface + dissolve(int $alpha) +

-

Returns a copy of current color, incrementing the alpha channel by the given amount

-

-

-
+ + + +
+

Returns a copy of current color, incrementing the alpha channel by the given amount.

+

Parameters

- +
- + - +
integerint $alpha -

Return Value

- +
- +
ColorInterface -
+

Exceptions

+ + + + + + +
RuntimeExceptionif the color type does not support transparency
+ +

See also

+ + + + + + +
+ ColorInterface::dissolve +
+
-

-
at line 94
- public ColorInterface - lighten(integer $shade) +

+
+

+
at line 109
+ ColorInterface + lighten(int $shade) +

-

Returns a copy of the current color, lightened by the specified number of shades

-

-

-
+ + + +
+

Returns a copy of the current color, lightened by the specified number of shades.

+

Parameters

- +
- + - +
integerint $shade -

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ ColorInterface::lighten +
+
-

-
at line 102
- public ColorInterface - darken(integer $shade) +

+
+

+
at line 119
+ ColorInterface + darken(int $shade) +

-

Returns a copy of the current color, darkened by the specified number of shades

-

-

-
+ + + +
+

Returns a copy of the current color, darkened by the specified number of shades.

+

Parameters

- +
- + - +
integerint $shade -

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ ColorInterface::darken +
+
-

-
at line 110
- public ColorInterface - grayscale() +

+
+

+
at line 129
+ ColorInterface + grayscale() +

-

Returns a gray related to the current color

-

-

-
+ + + +
+

Returns a gray related to the current color.

+

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ ColorInterface::grayscale +
+
-

-
at line 118
- public Boolean - isOpaque() +

+
+

+
at line 139
+ bool + isOpaque() +

-

Checks if the current color is opaque

-

-

-
+ + + +
+

Checks if the current color is opaque.

+

Return Value

- +
- - + +
Boolean -bool
+

See also

+ + + + + + +
+ ColorInterface::isOpaque +
+
-

-
at line 128
- public string - __toString() +

+
+

+
at line 149
+ string + __toString() +

-

Returns hex representation of the color

-

-

-
+ + + +
+

Returns hex representation of the color.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ ColorInterface::__toString +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/Color/RGB.html b/docs/API/API/Imagine/Image/Palette/Color/RGB.html index 04e237805..0450b0ba6 100644 --- a/docs/API/API/Imagine/Image/Palette/Color/RGB.html +++ b/docs/API/API/Imagine/Image/Palette/Color/RGB.html @@ -1,205 +1,264 @@ - - - - Imagine\Image\Palette\Color\RGB | - - - -
- - -
- -
Class
-

Imagine\Image\Palette\Color\RGB

+ + + + Imagine\Image\Palette\Color\RGB | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. Color
  9. \
  10. RGB
    11. +
+
+
+ +
+

+ RGB + +

+
+ +

class RGB implements - ColorInterface

+ ColorInterface +

+ + + +

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(RGB $palette, array $color, $alpha) -

-

-
- Integer - + +
+ __construct(RGB $palette, array $color, int $alpha) + +

No description

+
+
+ +
+
+ int|null +
+
getValue(string $component) -

Return the value of one of the component.

-
- integer - + +

Return the value of one of the component.

+
+ +
+
+ int +
+
getRed() -

Returns RED value of the color

-
- integer - + +

Returns RED value of the color (from 0 to 255).

+
+ +
+
+ int +
+
getGreen() -

Returns GREEN value of the color

-
- integer - + +

Returns GREEN value of the color (from 0 to 255).

+
+ +
+
+ int +
+
getBlue() -

Returns BLUE value of the color

-
+ +

Returns BLUE value of the color (from 0 to 255).

+
+ +
+
PaletteInterface -
+ +
getPalette() -

Returns the palette attached to the current color

-
- integer - + +

Returns the palette attached to the current color.

+
+ +
+
+ int|null +
+
getAlpha() -

Returns percentage of transparency of the color

-
+ +

Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).

+
+ +
+
ColorInterface -
- dissolve(integer $alpha) -

Returns a copy of current color, incrementing the alpha channel by the given amount

-
+ +
+ dissolve(int $alpha) + +

Returns a copy of current color, incrementing the alpha channel by the given amount.

+
+ +
+
ColorInterface -
- lighten(integer $shade) -

Returns a copy of the current color, lightened by the specified number of shades

-
+ +
+ lighten(int $shade) + +

Returns a copy of the current color, lightened by the specified number of shades.

+
+ +
+
ColorInterface -
- darken(integer $shade) -

Returns a copy of the current color, darkened by the specified number of shades

-
+ +
+ darken(int $shade) + +

Returns a copy of the current color, darkened by the specified number of shades.

+
+ +
+
ColorInterface -
+ +
grayscale() -

Returns a gray related to the current color

-
- Boolean - + +

Returns a gray related to the current color.

+
+ +
+
+ bool +
+
isOpaque() -

Checks if the current color is opaque

-
+ +

Checks if the current color is opaque.

+
+ +
+
string -
+ +
__toString() -

Returns hex representation of the color

-
+ +

Returns hex representation of the color.

+
+
+

Details

-

-
at line 45
- public - __construct(RGB $palette, array $color, $alpha) +
+
+

+
at line 49
+ + __construct(RGB $palette, array $color, int $alpha) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - + - + - +
RGB $palette -
array $color -
int $alpha -
@@ -209,19 +268,24 @@

Parameters

-

-
at line 55
- public Integer - getValue(string $component) +

+
+

+
at line 61
+ int|null + getValue(string $component) +

-

Return the value of one of the component.

-

-

-
+ + + +
+

Return the value of one of the component.

+

Parameters

- +
@@ -232,37 +296,60 @@

Parameters

Return Value

-
string $component
+
- - + +
Integer -int|null
+

Exceptions

+ + + + + + +
InvalidArgumentExceptionif $component is not valid
+ +

See also

+ + + + + + +
+ ColorInterface::getValue +
+
-

-
at line 74
- public integer - getRed() +

+
+

+
at line 80
+ int + getRed() +

-

Returns RED value of the color

-

-

-
+ + + +
+

Returns RED value of the color (from 0 to 255).

+

Return Value

- +
- - + +
integer -int
@@ -271,24 +358,28 @@

Return Value

-

-
at line 84
- public integer - getGreen() +

+
+

+
at line 90
+ int + getGreen() +

-

Returns GREEN value of the color

-

-

-
+ + + +
+

Returns GREEN value of the color (from 0 to 255).

+

Return Value

- +
- - + +
integer -int
@@ -297,24 +388,28 @@

Return Value

-

-
at line 94
- public integer - getBlue() +

+
+

+
at line 100
+ int + getBlue() +

-

Returns BLUE value of the color

-

-

-
+ + + +
+

Returns BLUE value of the color (from 0 to 255).

+

Return Value

- +
- - + +
integer -int
@@ -323,251 +418,384 @@

Return Value

-

-
at line 102
- public PaletteInterface - getPalette() +

+
+

+
at line 110
+ PaletteInterface + getPalette() +

-

Returns the palette attached to the current color

-

-

-
+ + + +
+

Returns the palette attached to the current color.

+

Return Value

- +
- +
PaletteInterface -
+

See also

+ + + + + + +
+ ColorInterface::getPalette +
+
-

-
at line 110
- public integer - getAlpha() +

+
+

+
at line 120
+ int|null + getAlpha() +

-

Returns percentage of transparency of the color

-

-

-
+ + + +
+

Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).

+

Return Value

- +
- - + +
integer -int|nullreturn NULL if the color type does not support transparency
+

See also

+ + + + + + +
+ ColorInterface::getAlpha +
+
-

-
at line 118
- public ColorInterface - dissolve(integer $alpha) +

+
+

+
at line 130
+ ColorInterface + dissolve(int $alpha) +

-

Returns a copy of current color, incrementing the alpha channel by the given amount

-

-

-
+ + + +
+

Returns a copy of current color, incrementing the alpha channel by the given amount.

+

Parameters

- +
- + - +
integerint $alpha -

Return Value

- +
- +
ColorInterface -
+

Exceptions

+ + + + + + +
RuntimeExceptionif the color type does not support transparency
+ +

See also

+ + + + + + +
+ ColorInterface::dissolve +
+
-

-
at line 126
- public ColorInterface - lighten(integer $shade) +

+
+

+
at line 143
+ ColorInterface + lighten(int $shade) +

-

Returns a copy of the current color, lightened by the specified number of shades

-

-

-
+ + + +
+

Returns a copy of the current color, lightened by the specified number of shades.

+

Parameters

- +
- + - +
integerint $shade -

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ ColorInterface::lighten +
+
-

-
at line 140
- public ColorInterface - darken(integer $shade) +

+
+

+
at line 159
+ ColorInterface + darken(int $shade) +

-

Returns a copy of the current color, darkened by the specified number of shades

-

-

-
+ + + +
+

Returns a copy of the current color, darkened by the specified number of shades.

+

Parameters

- +
- + - +
integerint $shade -

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ ColorInterface::darken +
+
-

-
at line 154
- public ColorInterface - grayscale() +

+
+

+
at line 175
+ ColorInterface + grayscale() +

-

Returns a gray related to the current color

-

-

-
+ + + +
+

Returns a gray related to the current color.

+

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ ColorInterface::grayscale +
+
-

-
at line 164
- public Boolean - isOpaque() +

+
+

+
at line 187
+ bool + isOpaque() +

-

Checks if the current color is opaque

-

-

-
+ + + +
+

Checks if the current color is opaque.

+

Return Value

- +
- - + +
Boolean -bool
+

See also

+ + + + + + +
+ ColorInterface::isOpaque +
+
-

-
at line 174
- public string - __toString() +

+
+

+
at line 197
+ string + __toString() +

-

Returns hex representation of the color

-

-

-
+ + + +
+

Returns hex representation of the color.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ ColorInterface::__toString +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/Color/namespace-frame.html b/docs/API/API/Imagine/Image/Palette/Color/namespace-frame.html deleted file mode 100644 index 8a781eea6..000000000 --- a/docs/API/API/Imagine/Image/Palette/Color/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Image\Palette\Color | - - - diff --git a/docs/API/API/Imagine/Image/Palette/ColorParser.html b/docs/API/API/Imagine/Image/Palette/ColorParser.html index 878e8420c..eedef3be6 100644 --- a/docs/API/API/Imagine/Image/Palette/ColorParser.html +++ b/docs/API/API/Imagine/Image/Palette/ColorParser.html @@ -1,112 +1,174 @@ - - - - Imagine\Image\Palette\ColorParser | - - - -
- + + + + Imagine\Image\Palette\ColorParser | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
-
+
+
+ -
Class
-

Imagine\Image\Palette\ColorParser

+
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. ColorParser
    9. +
+
+
+ +
+

+ ColorParser + +

-
-

class - ColorParser

+

class + ColorParser +

+ + + + +

Methods

- - - - - - - - - - - - - - - - -
+
+
+
array -
- parseToRGB(string|array|integer $color) -

Parses a color to a RGB tuple

-
- array - - parseToCMYK(string|array|integer $color) -

Parses a color to a CMYK tuple

-
+ +
+ parseToRGB(string|array|int $color) + +

Parses a color to a RGB tuple.

+
+ +
+
array -
- parseToGrayscale(string|array|integer $color) -

Parses a color to a grayscale value

-
+
+
+ parseToCMYK(string|array|int $color) + +

Parses a color to a CMYK tuple.

+
+
+
+
+ int[] +
+
+ parseToGrayscale(string|array|int $color) + +

Parses a color to a grayscale value.

+
+
+

Details

-

-
at line 27
- public array - parseToRGB(string|array|integer $color) +
+
+

+
at line 27
+ array + parseToRGB(string|array|int $color) +

-

Parses a color to a RGB tuple

-

-

-
+ + + +
+

Parses a color to a RGB tuple.

+

Parameters

- +
- + - +
string|array|integerstring|array|int $color -

Return Value

- +
- +
array -

Exceptions

- +
- - + +
InvalidArgumentException -InvalidArgumentException
@@ -114,46 +176,48 @@

Exceptions

-

-
at line 51
- public array - parseToCMYK(string|array|integer $color) +

+
+

+
at line 51
+ array + parseToCMYK(string|array|int $color) +

-

Parses a color to a CMYK tuple

-

-

-
+ + + +
+

Parses a color to a CMYK tuple.

+

Parameters

- +
- + - +
string|array|integerstring|array|int $color -

Return Value

- +
- +
array -

Exceptions

- +
- - + +
InvalidArgumentException -InvalidArgumentException
@@ -161,46 +225,48 @@

Exceptions

-

-
at line 82
- public array - parseToGrayscale(string|array|integer $color) +

+
+

+
at line 82
+ int[] + parseToGrayscale(string|array|int $color) +

-

Parses a color to a grayscale value

-

-

-
+ + + +
+

Parses a color to a grayscale value.

+

Parameters

- +
- + - +
string|array|integerstring|array|int $color -

Return Value

- +
- - + +
array -int[]

Exceptions

- +
- - + +
InvalidArgumentException -InvalidArgumentException
@@ -208,10 +274,17 @@

Exceptions

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/Grayscale.html b/docs/API/API/Imagine/Image/Palette/Grayscale.html index 6bfa4d49d..0a37cc181 100644 --- a/docs/API/API/Imagine/Image/Palette/Grayscale.html +++ b/docs/API/API/Imagine/Image/Palette/Grayscale.html @@ -1,301 +1,511 @@ - - - - Imagine\Image\Palette\Grayscale | - - - -
- - -
- -
Class
-

Imagine\Image\Palette\Grayscale

+ + + + Imagine\Image\Palette\Grayscale | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. Grayscale
    9. +
+
+
+ +
+

+ Grayscale + +

+
+ +

class Grayscale implements - PaletteInterface

+ PaletteInterface +

+ + +
+

The grayscale palette.

-

Methods

+ +

Properties

- +
- - + + - - -
- - - __construct() -

-

+ 		+ static protected Gray[] $colors
- String - +
+ + +

Methods

+ +
+
+
+ +
+
+ __construct() + +

No description

+
+
+
+
+
+ string +
+
name() -

Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants

- - - - - - array - - + +

Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.

+
+
+
+
+ string[] +
+
pixelDefinition() -

Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.

- - - - - - Boolean - - + +

Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.

+
+
+
+
+ bool +
+
supportsAlpha() -

Tells if alpha channel is supported in this palette

- - - - - - PaletteInterface - - + +

Tells if alpha channel is supported in this palette.

+
+
+
+
+ int +
+
+ getChannelsMaxValue() + +

Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).

+
+
+
+
+ $this +
+
useProfile(ProfileInterface $profile) -

Attachs an ICC profile to this Palette.

- - - - - + +

Attachs an ICC profile to this Palette.

+
+
+
+
ProfileInterface - - +
+
profile() -

Returns the ICC profile attached to this Palette.

- - - - - + +

Returns the ICC profile attached to this Palette.

+
+
+
+
ColorInterface - - - color(string|array|integer $color, integer|null $alpha = null) -

Returns a color given some values

- - - - - +
+
+ color(string|int[]|int $color, int|null $alpha = null) + +

Returns a color given some values.

+
+
+
+
ColorInterface - - +
+
blend(ColorInterface $color1, ColorInterface $color2, float $amount) -

Blend two colors given an amount

- - - - + +

Blend two colors given an amount.

+
+
+

Details

-

-
at line 37
- public - __construct() +
+
+

+
at line 40
+ + __construct() +

-

-

-

-

-
+ + + +
-

-
at line 45
- public String - name() +

+
+

+
at line 50
+ string + name() +

-

Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants

-

-

-
+ + + +
+

Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.

+

Return Value

- +
- - + +
String -string
+

See also

+ + + + + + +
+ PaletteInterface::name +
+
-

-
at line 53
- public array - pixelDefinition() +

+
+

+
at line 60
+ string[] + pixelDefinition() +

-

Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.

-

-

-
+ + + +
+

Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.

+

Return Value

- +
- - + +
array -string[]
+

See also

+ + + + + + +
+ PaletteInterface::pixelDefinition +
+
-

-
at line 61
- public Boolean - supportsAlpha() +

+
+

+
at line 70
+ bool + supportsAlpha() +

-

Tells if alpha channel is supported in this palette

-

-

-
+ + + +
+

Tells if alpha channel is supported in this palette.

+
+ +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + + + +
+ PaletteInterface::supportsAlpha +
+ +
+
+ +
+
+

+
at line 80
+ int + getChannelsMaxValue() + +

+
+ + + +
+

Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).

+

Return Value

- +
- - + +
Boolean -int
+

See also

+ + + + + + +
+ PaletteInterface::getChannelsMaxValue +
+
-

-
at line 69
- public PaletteInterface - useProfile(ProfileInterface $profile) +

+
+

+
at line 90
+ $this + useProfile(ProfileInterface $profile) +

-

Attachs an ICC profile to this Palette.

-

(A default profile is provided by default)

-
+ + + +
+

Attachs an ICC profile to this Palette.

(A default profile is provided by default)

+

Parameters

- +
- +
ProfileInterface $profile -

Return Value

- +
- - + +
PaletteInterface -$this
+

See also

+ + + + + + +
+ PaletteInterface::useProfile +
+
-

-
at line 79
- public ProfileInterface - profile() +

+
+

+
at line 102
+ ProfileInterface + profile() +

-

Returns the ICC profile attached to this Palette.

-

-

-
+ + + +
+

Returns the ICC profile attached to this Palette.

+

Return Value

- +
- +
ProfileInterface -
+

See also

+ + + + + + +
+ PaletteInterface::profile +
+
-

-
at line 91
- public ColorInterface - color(string|array|integer $color, integer|null $alpha = null) +

+
+

+
at line 116
+ ColorInterface + color(string|int[]|int $color, int|null $alpha = null) +

-

Returns a color given some values

-

-

-
+ + + +
+

Returns a color given some values.

+

Parameters

- +
- + - + @@ -304,52 +514,65 @@

Parameters

Return Value

-
string|array|integerstring|int[]|int $color A color
integer|nullint|null $alpha Set alpha to null to disable it
+
- +
ColorInterface -

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException In case you pass an alpha value to a Palette that does not support alpha
+

See also

+ + + + + + +
+ PaletteInterface::color +
+
-

-
at line 110
- public ColorInterface - blend(ColorInterface $color1, ColorInterface $color2, float $amount) +

+
+

+
at line 137
+ ColorInterface + blend(ColorInterface $color1, ColorInterface $color2, float $amount) +

-

Blend two colors given an amount

-

-

-
+ + + +
+

Blend two colors given an amount.

+

Parameters

- +
- + - + @@ -361,23 +584,40 @@

Parameters

Return Value

-
ColorInterface $color1 -
ColorInterface $color2 -
float
+
- +
ColorInterface -
+

See also

+ + + + + + +
+ PaletteInterface::blend +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/PaletteInterface.html b/docs/API/API/Imagine/Image/Palette/PaletteInterface.html index 0d655d019..7e70e03de 100644 --- a/docs/API/API/Imagine/Image/Palette/PaletteInterface.html +++ b/docs/API/API/Imagine/Image/Palette/PaletteInterface.html @@ -1,60 +1,116 @@ - - - - Imagine\Image\Palette\PaletteInterface | - - - -
- - -
- -
Interface
-

Imagine\Image\Palette\PaletteInterface

+ + + + Imagine\Image\Palette\PaletteInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. PaletteInterface
    9. +
+
+
+ +
+

+ PaletteInterface + +

-
-

interface - PaletteInterface

+

interface + PaletteInterface +

+ + + + +
+

Interface that any palette must implement.

+

Constants

- +
PALETTE_GRAYSCALE -

-

-

-

+

Palette name: grayscale.

+

PALETTE_RGB -

-

-

-

+

Palette name: RGB.

+

PALETTE_CMYK -

-

-

-

+

Palette name: CMYK.

+

@@ -63,102 +119,118 @@

Constants

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
ColorInterface -
- color(string|array|integer $color, integer|null $alpha = null) -

Returns a color given some values

-
+ +
+ color(string|int[]|int $color, int|null $alpha = null) + +

Returns a color given some values.

+
+ +
+
ColorInterface -
+ +
blend(ColorInterface $color1, ColorInterface $color2, float $amount) -

Blend two colors given an amount

-
- PaletteInterface - + +

Blend two colors given an amount.

+
+ +
+
+ $this +
+
useProfile(ProfileInterface $profile) -

Attachs an ICC profile to this Palette.

-
+ +

Attachs an ICC profile to this Palette.

+
+ +
+
ProfileInterface -
+ +
profile() -

Returns the ICC profile attached to this Palette.

-
- String - + +

Returns the ICC profile attached to this Palette.

+
+ +
+
+ string +
+
name() -

Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants

-
- array - + +

Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.

+
+ +
+
+ string[] +
+
pixelDefinition() -

Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.

-
- Boolean - + +

Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.

+
+ +
+
+ bool +
+
supportsAlpha() -

Tells if alpha channel is supported in this palette

-
+ +

Tells if alpha channel is supported in this palette.

+
+
+
+
+ int +
+
+ getChannelsMaxValue() + +

Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).

+
+
+

Details

-

-
at line 34
- public ColorInterface - color(string|array|integer $color, integer|null $alpha = null) +
+
+

+
at line 53
+ ColorInterface + color(string|int[]|int $color, int|null $alpha = null) +

-

Returns a color given some values

-

-

-
+ + + +
+

Returns a color given some values.

+

Parameters

- +
- + - + @@ -167,20 +239,19 @@

Parameters

Return Value

-
string|array|integerstring|int[]|int $color A color
integer|nullint|null $alpha Set alpha to null to disable it
+
- +
ColorInterface -

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException In case you pass an alpha value to a Palette that does not support alpha
@@ -189,30 +260,33 @@

Exceptions

-

-
at line 45
- public ColorInterface - blend(ColorInterface $color1, ColorInterface $color2, float $amount) +

+
+

+
at line 64
+ ColorInterface + blend(ColorInterface $color1, ColorInterface $color2, float $amount) +

-

Blend two colors given an amount

-

-

-
+ + + +
+

Blend two colors given an amount.

+

Parameters

- +
- + - + @@ -224,11 +298,10 @@

Parameters

Return Value

-
ColorInterface $color1 -
ColorInterface $color2 -
float
+
- +
ColorInterface -
@@ -237,34 +310,38 @@

Return Value

-

-
at line 56
- public PaletteInterface - useProfile(ProfileInterface $profile) +

+
+

+
at line 75
+ $this + useProfile(ProfileInterface $profile) +

-

Attachs an ICC profile to this Palette.

-

(A default profile is provided by default)

-
+ + + +
+

Attachs an ICC profile to this Palette.

(A default profile is provided by default)

+

Parameters

- +
- +
ProfileInterface $profile -

Return Value

- +
- - + +
PaletteInterface -$this
@@ -273,24 +350,28 @@

Return Value

-

-
at line 63
- public ProfileInterface - profile() +

+
+

+
at line 82
+ ProfileInterface + profile() +

-

Returns the ICC profile attached to this Palette.

-

-

-
+ + + +
+

Returns the ICC profile attached to this Palette.

+

Return Value

- +
- +
ProfileInterface -
@@ -299,24 +380,28 @@

Return Value

-

-
at line 71
- public String - name() +

+
+

+
at line 89
+ string + name() +

-

Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants

-

-

-
+ + + +
+

Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.

+

Return Value

- +
- - + +
String -string
@@ -325,24 +410,29 @@

Return Value

-

-
at line 79
- public array - pixelDefinition() +

+
+

+
at line 97
+ string[] + pixelDefinition() +

-

Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.

-

-

-
+ + + +
+

Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.

+

Return Value

- +
- - + +
array -string[]
@@ -351,24 +441,28 @@

Return Value

-

-
at line 86
- public Boolean - supportsAlpha() +

+
+

+
at line 104
+ bool + supportsAlpha() +

-

Tells if alpha channel is supported in this palette

-

-

-
+ + + +
+

Tells if alpha channel is supported in this palette.

+

Return Value

- +
- - + +
Boolean -bool
@@ -377,10 +471,47 @@

Return Value

+
+
+

+
at line 111
+ int + getChannelsMaxValue() + +

+
+ + +
+

Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).

+
+ +

Return Value

+ + + + + + +
int
+ + + +
+
+
- + + +
+ + +
+ diff --git a/docs/API/API/Imagine/Image/Palette/RGB.html b/docs/API/API/Imagine/Image/Palette/RGB.html index 031c95f2f..2d943a8b4 100644 --- a/docs/API/API/Imagine/Image/Palette/RGB.html +++ b/docs/API/API/Imagine/Image/Palette/RGB.html @@ -1,301 +1,511 @@ - - - - Imagine\Image\Palette\RGB | - - - -
- - -
- -
Class
-

Imagine\Image\Palette\RGB

+ + + + Imagine\Image\Palette\RGB | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Palette
  7. \
  8. RGB
    9. +
+
+
+ +
+

+ RGB + +

+
+ +

class RGB implements - PaletteInterface

+ PaletteInterface +

+ + +
+

The RGB palette.

-

Methods

+ +

Properties

- +
- - + + - - -
- - - __construct() -

-

+ 		+ static protected RGB[] $colors
- String - +
+ + +

Methods

+ +
+
+
+ +
+
+ __construct() + +

No description

+
+
+
+
+
+ string +
+
name() -

Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants

- - - - - - array - - + +

Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.

+
+
+
+
+ string[] +
+
pixelDefinition() -

Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.

- - - - - - Boolean - - + +

Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.

+
+
+
+
+ bool +
+
supportsAlpha() -

Tells if alpha channel is supported in this palette

- - - - - - PaletteInterface - - + +

Tells if alpha channel is supported in this palette.

+
+
+
+
+ int +
+
+ getChannelsMaxValue() + +

Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).

+
+
+
+
+ $this +
+
useProfile(ProfileInterface $profile) -

Attachs an ICC profile to this Palette.

- - - - - + +

Attachs an ICC profile to this Palette.

+
+
+
+
ProfileInterface - - +
+
profile() -

Returns the ICC profile attached to this Palette.

- - - - - + +

Returns the ICC profile attached to this Palette.

+
+
+
+
ColorInterface - - - color(string|array|integer $color, integer|null $alpha = null) -

Returns a color given some values

- - - - - +
+
+ color(string|int[]|int $color, int|null $alpha = null) + +

Returns a color given some values.

+
+
+
+
ColorInterface - - +
+
blend(ColorInterface $color1, ColorInterface $color2, float $amount) -

Blend two colors given an amount

- - - - + +

Blend two colors given an amount.

+
+
+

Details

-

-
at line 37
- public - __construct() +
+
+

+
at line 40
+ + __construct() +

-

-

-

-

-
+ + + +
-

-
at line 45
- public String - name() +

+
+

+
at line 50
+ string + name() +

-

Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants

-

-

-
+ + + +
+

Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.

+

Return Value

- +
- - + +
String -string
+

See also

+ + + + + + +
+ PaletteInterface::name +
+
-

-
at line 53
- public array - pixelDefinition() +

+
+

+
at line 60
+ string[] + pixelDefinition() +

-

Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.

-

-

-
+ + + +
+

Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.

+

Return Value

- +
- - + +
array -string[]
+

See also

+ + + + + + +
+ PaletteInterface::pixelDefinition +
+
-

-
at line 65
- public Boolean - supportsAlpha() +

+
+

+
at line 74
+ bool + supportsAlpha() +

-

Tells if alpha channel is supported in this palette

-

-

-
+ + + +
+

Tells if alpha channel is supported in this palette.

+
+ +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + + + +
+ PaletteInterface::supportsAlpha +
+ +
+
+ +
+
+

+
at line 84
+ int + getChannelsMaxValue() + +

+
+ + + +
+

Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).

+

Return Value

- +
- - + +
Boolean -int
+

See also

+ + + + + + +
+ PaletteInterface::getChannelsMaxValue +
+
-

-
at line 73
- public PaletteInterface - useProfile(ProfileInterface $profile) +

+
+

+
at line 94
+ $this + useProfile(ProfileInterface $profile) +

-

Attachs an ICC profile to this Palette.

-

(A default profile is provided by default)

-
+ + + +
+

Attachs an ICC profile to this Palette.

(A default profile is provided by default)

+

Parameters

- +
- +
ProfileInterface $profile -

Return Value

- +
- - + +
PaletteInterface -$this
+

See also

+ + + + + + +
+ PaletteInterface::useProfile +
+
-

-
at line 83
- public ProfileInterface - profile() +

+
+

+
at line 106
+ ProfileInterface + profile() +

-

Returns the ICC profile attached to this Palette.

-

-

-
+ + + +
+

Returns the ICC profile attached to this Palette.

+

Return Value

- +
- +
ProfileInterface -
+

See also

+ + + + + + +
+ PaletteInterface::profile +
+
-

-
at line 95
- public ColorInterface - color(string|array|integer $color, integer|null $alpha = null) +

+
+

+
at line 120
+ ColorInterface + color(string|int[]|int $color, int|null $alpha = null) +

-

Returns a color given some values

-

-

-
+ + + +
+

Returns a color given some values.

+

Parameters

- +
- + - + @@ -304,52 +514,65 @@

Parameters

Return Value

-
string|array|integerstring|int[]|int $color A color
integer|nullint|null $alpha Set alpha to null to disable it
+
- +
ColorInterface -

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException In case you pass an alpha value to a Palette that does not support alpha
+

See also

+ + + + + + +
+ PaletteInterface::color +
+
-

-
at line 114
- public ColorInterface - blend(ColorInterface $color1, ColorInterface $color2, float $amount) +

+
+

+
at line 141
+ ColorInterface + blend(ColorInterface $color1, ColorInterface $color2, float $amount) +

-

Blend two colors given an amount

-

-

-
+ + + +
+

Blend two colors given an amount.

+

Parameters

- +
- + - + @@ -361,23 +584,40 @@

Parameters

Return Value

-
ColorInterface $color1 -
ColorInterface $color2 -
float
+
- +
ColorInterface -
+

See also

+ + + + + + +
+ PaletteInterface::blend +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Palette/namespace-frame.html b/docs/API/API/Imagine/Image/Palette/namespace-frame.html deleted file mode 100644 index d9ce4ed13..000000000 --- a/docs/API/API/Imagine/Image/Palette/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Image\Palette | - - - diff --git a/docs/API/API/Imagine/Image/Point.html b/docs/API/API/Imagine/Image/Point.html index d237724ba..666343f61 100644 --- a/docs/API/API/Imagine/Image/Point.html +++ b/docs/API/API/Imagine/Image/Point.html @@ -1,132 +1,192 @@ - - - - Imagine\Image\Point | - - - -
- + + + + Imagine\Image\Point | Imagine API v1.2.5-dev + + + + + + + + + + + + + + -
+ +
+
+
+ +
+ + +
+
+ +
+ +
+
+ -
Class
-

Imagine\Image\Point

+
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Point
    7. +
+
+
+ +
+

+ Point + +

-
-

class + +

class Point implements - PointInterface

+ PointInterface +

+ + +
-

The point class

-

-

-
+

The point class.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(integer $x, integer $y) -

Constructs a point of coordinates

-
- integer - + +
+ __construct(int $x, int $y) + +

Constructs a point of coordinates.

+
+ +
+
+ int +
+
getX() -

Gets points x coordinate

-
- integer - + +

Gets points x coordinate.

+
+ +
+
+ int +
+
getY() -

Gets points y coordinate

-
- Boolean - + +

Gets points y coordinate.

+
+ +
+
+ bool +
+
in(BoxInterface $box) -

Checks if current coordinate is inside a given bo

-
- ImageInterface - - move(integer $amount) -

Returns another point, moved by a given amount from current coordinates

-
+ +

Checks if current coordinate is inside a given box.

+
+ +
+
+ PointInterface +
+
+ move(int $amount) + +

Returns another point, moved by a given amount from current coordinates.

+
+
+
+
string -
+ +
__toString() -

Gets a string representation for the current point

-
+ +

Gets a string representation for the current point.

+
+
+

Details

-

-
at line 39
- public - __construct(integer $x, integer $y) +
+
+

+
at line 39
+ + __construct(int $x, int $y) +

-

Constructs a point of coordinates

-

-

-
+ + + +
+

Constructs a point of coordinates.

+

Parameters

- +
- + - + - + - +
integerint $x -
integerint $y -
@@ -134,11 +194,10 @@

Parameters

Exceptions

- +
- - + +
InvalidArgumentException -InvalidArgumentException
@@ -146,162 +205,242 @@

Exceptions

-

-
at line 52
- public integer - getX() +

+
+

+
at line 54
+ int + getX() +

-

Gets points x coordinate

-

-

-
+ + + +
+

Gets points x coordinate.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ PointInterface::getX +
+
-

-
at line 60
- public integer - getY() +

+
+

+
at line 64
+ int + getY() +

-

Gets points y coordinate

-

-

-
+ + + +
+

Gets points y coordinate.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ PointInterface::getY +
+
-

-
at line 68
- public Boolean - in(BoxInterface $box) +

+
+

+
at line 74
+ bool + in(BoxInterface $box) +

-

Checks if current coordinate is inside a given bo

-

-

-
+ + + +
+

Checks if current coordinate is inside a given box.

+

Parameters

- +
- +
BoxInterface $box -

Return Value

- +
- - + +
Boolean -bool
+

See also

+ + + + + + +
+ PointInterface::in +
+
-

-
at line 76
- public ImageInterface - move(integer $amount) +

+
+

+
at line 84
+ PointInterface + move(int $amount) +

-

Returns another point, moved by a given amount from current coordinates

-

-

-
+ + + +
+

Returns another point, moved by a given amount from current coordinates.

+

Parameters

- +
- + - +
integerint $amount -

Return Value

- +
- - + +
ImageInterface -PointInterface
+

See also

+ + + + + + +
+ PointInterface::move +
+
-

-
at line 84
- public string - __toString() +

+
+

+
at line 94
+ string + __toString() +

-

Gets a string representation for the current point

-

-

-
+ + + +
+

Gets a string representation for the current point.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ PointInterface::__toString +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Point/Center.html b/docs/API/API/Imagine/Image/Point/Center.html index 93672687e..01c04e48d 100644 --- a/docs/API/API/Imagine/Image/Point/Center.html +++ b/docs/API/API/Imagine/Image/Point/Center.html @@ -1,126 +1,187 @@ - - - - Imagine\Image\Point\Center | - - - -
- + + + + Imagine\Image\Point\Center | Imagine API v1.2.5-dev + + + + + + + + + + + + + + -
+ +
+
+
+ +
+ + +
+
+ +
+ +
+
+ -
Class
-

Imagine\Image\Point\Center

+
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Point
  7. \
  8. Center
    9. +
+
+
+ +
+

+ Center + +

-
-

class + +

class Center implements - PointInterface

+ PointInterface +

+ + +
-

Point center

-

-

-
+

Center point of a box.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
+ +
__construct(BoxInterface $box) -

Constructs coordinate with size instance, it needs to be relative to

-
- integer - + +

Constructs coordinate with size instance, it needs to be relative to.

+
+ +
+
+ int +
+
getX() -

Gets points x coordinate

-
- integer - + +

Gets points x coordinate.

+
+ +
+
+ int +
+
getY() -

Gets points y coordinate

-
- Boolean - + +

Gets points y coordinate.

+
+ +
+
+ bool +
+
in(BoxInterface $box) -

Checks if current coordinate is inside a given bo

-
- ImageInterface - - move(integer $amount) -

Returns another point, moved by a given amount from current coordinates

-
+ +

Checks if current coordinate is inside a given box.

+
+ +
+
+ PointInterface +
+
+ move(int $amount) + +

Returns another point, moved by a given amount from current coordinates.

+
+
+
+
string -
+ +
__toString() -

Gets a string representation for the current point

-
+ +

Gets a string representation for the current point.

+
+
+

Details

-

-
at line 33
- public - __construct(BoxInterface $box) +
+
+

+
at line 33
+ + __construct(BoxInterface $box) +

-

Constructs coordinate with size instance, it needs to be relative to

-

-

-
+ + + +
+

Constructs coordinate with size instance, it needs to be relative to.

+

Parameters

- +
- +
BoxInterface $box -
@@ -130,162 +191,242 @@

Parameters

-

-
at line 41
- public integer - getX() +

+
+

+
at line 43
+ int + getX() +

-

Gets points x coordinate

-

-

-
+ + + +
+

Gets points x coordinate.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ PointInterface::getX +
+
-

-
at line 49
- public integer - getY() +

+
+

+
at line 53
+ int + getY() +

-

Gets points y coordinate

-

-

-
+ + + +
+

Gets points y coordinate.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ PointInterface::getY +
+
-

-
at line 57
- public Boolean - in(BoxInterface $box) +

+
+

+
at line 63
+ bool + in(BoxInterface $box) +

-

Checks if current coordinate is inside a given bo

-

-

-
+ + + +
+

Checks if current coordinate is inside a given box.

+

Parameters

- +
- +
BoxInterface $box -

Return Value

- +
- - + +
Boolean -bool
+

See also

+ + + + + + +
+ PointInterface::in +
+
-

-
at line 65
- public ImageInterface - move(integer $amount) +

+
+

+
at line 73
+ PointInterface + move(int $amount) +

-

Returns another point, moved by a given amount from current coordinates

-

-

-
+ + + +
+

Returns another point, moved by a given amount from current coordinates.

+

Parameters

- +
- + - +
integerint $amount -

Return Value

- +
- - + +
ImageInterface -PointInterface
+

See also

+ + + + + + +
+ PointInterface::move +
+
-

-
at line 73
- public string - __toString() +

+
+

+
at line 83
+ string + __toString() +

-

Gets a string representation for the current point

-

-

-
+ + + +
+

Gets a string representation for the current point.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ PointInterface::__toString +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/Point/namespace-frame.html b/docs/API/API/Imagine/Image/Point/namespace-frame.html deleted file mode 100644 index 5340791aa..000000000 --- a/docs/API/API/Imagine/Image/Point/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Image\Point | - - - diff --git a/docs/API/API/Imagine/Image/PointInterface.html b/docs/API/API/Imagine/Image/PointInterface.html index 2c6a35b1e..5cbaae041 100644 --- a/docs/API/API/Imagine/Image/PointInterface.html +++ b/docs/API/API/Imagine/Image/PointInterface.html @@ -1,115 +1,176 @@ - - - - Imagine\Image\PointInterface | - - - -
- - -
- -
Interface
-

Imagine\Image\PointInterface

+ + + + Imagine\Image\PointInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

interface - PointInterface

-
-

The point interface

-

-

+
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. PointInterface
    7. +
+
+
+ +
+

+ PointInterface + +

+
+ +

interface + PointInterface +

+ + + + +
+

The point interface.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - -
- integer - +
+
+
+ int +
+
getX() -

Gets points x coordinate

-
- integer - + +

Gets points x coordinate.

+
+ +
+
+ int +
+
getY() -

Gets points y coordinate

-
- Boolean - + +

Gets points y coordinate.

+
+ +
+
+ bool +
+
in(BoxInterface $box) -

Checks if current coordinate is inside a given bo

-
- ImageInterface - - move(integer $amount) -

Returns another point, moved by a given amount from current coordinates

-
+ +

Checks if current coordinate is inside a given box.

+
+ +
+
+ PointInterface +
+
+ move(int $amount) + +

Returns another point, moved by a given amount from current coordinates.

+
+
+
+
string -
+ +
__toString() -

Gets a string representation for the current point

-
+ +

Gets a string representation for the current point.

+
+
+

Details

-

-
at line 24
- public integer - getX() +
+
+

+
at line 24
+ int + getX() +

-

Gets points x coordinate

-

-

-
+ + + +
+

Gets points x coordinate.

+

Return Value

- +
- - + +
integer -int
@@ -118,24 +179,28 @@

Return Value

-

-
at line 31
- public integer - getY() +

+
+

+
at line 31
+ int + getY() +

-

Gets points y coordinate

-

-

-
+ + + +
+

Gets points y coordinate.

+

Return Value

- +
- - + +
integer -int
@@ -144,35 +209,38 @@

Return Value

-

-
at line 40
- public Boolean - in(BoxInterface $box) +

+
+

+
at line 40
+ bool + in(BoxInterface $box) +

-

Checks if current coordinate is inside a given bo

-

-

-
+ + + +
+

Checks if current coordinate is inside a given box.

+

Parameters

- +
- +
BoxInterface $box -

Return Value

- +
- - + +
Boolean -bool
@@ -181,35 +249,38 @@

Return Value

-

-
at line 48
- public ImageInterface - move(integer $amount) +

+
+

+
at line 49
+ PointInterface + move(int $amount) +

-

Returns another point, moved by a given amount from current coordinates

-

-

-
+ + + +
+

Returns another point, moved by a given amount from current coordinates.

+

Parameters

- +
- + - +
integerint $amount -

Return Value

- +
- - + +
ImageInterface -PointInterface
@@ -218,24 +289,28 @@

Return Value

-

-
at line 55
- public string - __toString() +

+
+

+
at line 56
+ string + __toString() +

-

Gets a string representation for the current point

-

-

-
+ + + +
+

Gets a string representation for the current point.

+

Return Value

- +
- +
string -
@@ -244,10 +319,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/PointSigned.html b/docs/API/API/Imagine/Image/PointSigned.html new file mode 100644 index 000000000..9776d878e --- /dev/null +++ b/docs/API/API/Imagine/Image/PointSigned.html @@ -0,0 +1,446 @@ + + + + + + Imagine\Image\PointSigned | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. PointSigned
    7. +
+
+
+ +
+

+ PointSigned + +

+
+ +

class + PointSigned implements + PointInterface +

+ + + + +
+

A point class that allows negative values of coordinates.

+ + + + +

Methods

+ +
+
+
+ +
+
+ __construct(int $x, int $y) + +

Constructs a point of coordinates.

+
+
+
+
+ int +
+
+ getX() + +

Gets points x coordinate.

+
+
+
+
+ int +
+
+ getY() + +

Gets points y coordinate.

+
+
+
+
+ bool +
+
+ in(BoxInterface $box) + +

Checks if current coordinate is inside a given box.

+
+
+
+
+ PointInterface +
+
+ move(int $amount) + +

Returns another point, moved by a given amount from current coordinates.

+
+
+
+
+ string +
+
+ __toString() + +

Gets a string representation for the current point.

+
+
+
+ + +

Details

+ +
+
+

+
at line 37
+ + __construct(int $x, int $y) + +

+
+ + + +
+

Constructs a point of coordinates.

+
+

Parameters

+ + + + + + + + + + + + +
int$x
int$y
+ + + +

Exceptions

+ + + + + + +
InvalidArgumentException
+ + +
+
+ +
+
+

+
at line 48
+ int + getX() + +

+
+ + + +
+

Gets points x coordinate.

+
+ +

Return Value

+ + + + + + +
int
+ + + +

See also

+ + + + + + +
+ PointInterface::getX +
+ +
+
+ +
+
+

+
at line 58
+ int + getY() + +

+
+ + + +
+

Gets points y coordinate.

+
+ +

Return Value

+ + + + + + +
int
+ + + +

See also

+ + + + + + +
+ PointInterface::getY +
+ +
+
+ +
+
+

+
at line 68
+ bool + in(BoxInterface $box) + +

+
+ + + +
+

Checks if current coordinate is inside a given box.

+
+

Parameters

+ + + + + + + +
BoxInterface$box
+ + +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + + + +
+ PointInterface::in +
+ +
+
+ +
+
+

+
at line 78
+ PointInterface + move(int $amount) + +

+
+ + + +
+

Returns another point, moved by a given amount from current coordinates.

+
+

Parameters

+ + + + + + + +
int$amount
+ + +

Return Value

+ + + + + + +
PointInterface
+ + + +

See also

+ + + + + + +
+ PointInterface::move +
+ +
+
+ +
+
+

+
at line 88
+ string + __toString() + +

+
+ + + +
+

Gets a string representation for the current point.

+
+ +

Return Value

+ + + + + + +
string
+ + + +

See also

+ + + + + + +
+ PointInterface::__toString +
+ +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Image/Profile.html b/docs/API/API/Imagine/Image/Profile.html index 1c0687480..dd2e47388 100644 --- a/docs/API/API/Imagine/Image/Profile.html +++ b/docs/API/API/Imagine/Image/Profile.html @@ -1,109 +1,171 @@ - - - - Imagine\Image\Profile | - - - -
- - -
- -
Class
-

Imagine\Image\Profile

+ + + + Imagine\Image\Profile | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. Profile
    7. +
+
+
+ +
+

+ Profile + +

+
+ +

class Profile implements - ProfileInterface

+ ProfileInterface +

+ + + +
+

The default implementation of ProfileInterface.

+

Methods

- - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct($name, $data) -

-

-
- String - + +
+ __construct(string $name, string $data) + +

No description

+
+
+ +
+
+ string +
+
name() -

Returns the name of the profile

-
- String - + +

Returns the name of the profile.

+
+ +
+
+ string +
+
data() -

Returns the profile data

-
+ +

Returns the profile data.

+
+ +
+
static Profile -
- fromPath(String $path) -

Creates a profile from a path to a file

-
+
+
+ fromPath(string $path) + +

Creates a profile from a path to a file.

+
+
+

Details

-

-
at line 21
- public - __construct($name, $data) +
+
+

+
at line 35
+ + __construct(string $name, string $data) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - + - + - +
string $name -
string $data -
@@ -113,96 +175,129 @@

Parameters

-

-
at line 30
- public String - name() +

+
+

+
at line 46
+ string + name() +

-

Returns the name of the profile

-

-

-
+ + + +
+

Returns the name of the profile.

+

Return Value

- +
- - + +
String -string
+

See also

+ + + + + + +
+ ProfileInterface::name +
+
-

-
at line 38
- public String - data() +

+
+

+
at line 56
+ string + data() +

-

Returns the profile data

-

-

-
+ + + +
+

Returns the profile data.

+

Return Value

- +
- - + +
String -string
+

See also

+ + + + + + +
+ ProfileInterface::data +
+
-

-
at line 52
- static public Profile - fromPath(String $path) +

+
+

+
at line 70
+ static Profile + fromPath(string $path) +

-

Creates a profile from a path to a file

-

-

-
+ + + +
+

Creates a profile from a path to a file.

+

Parameters

- +
- + - +
Stringstring $path -

Return Value

- +
- +
Profile -

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException In case the provided path is not valid
@@ -211,10 +306,17 @@

Exceptions

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/ProfileInterface.html b/docs/API/API/Imagine/Image/ProfileInterface.html index f2a4ff596..8a5ace8b0 100644 --- a/docs/API/API/Imagine/Image/ProfileInterface.html +++ b/docs/API/API/Imagine/Image/ProfileInterface.html @@ -1,80 +1,144 @@ - - - - Imagine\Image\ProfileInterface | - - - -
- + + + + Imagine\Image\ProfileInterface | Imagine API v1.2.5-dev + + + + + + + + + + + + + + -
+ +
+
+
+ +
+ + +
+
+ +
+ +
+
+ -
Interface
-

Imagine\Image\ProfileInterface

+
+
    +
  1. interface
    2. +
  2. Imagine
  3. \
  4. Image
  5. \
  6. ProfileInterface
    7. +
+
+
+ +
+

+ ProfileInterface + +

-
-

interface - ProfileInterface

+

interface + ProfileInterface +

+ + + + +

Methods

- - - - - - - - - - - -
- String - +
+
+
+ string +
+
name() -

Returns the name of the profile

-
- String - + +

Returns the name of the profile.

+
+ +
+
+ string +
+
data() -

Returns the profile data

-
+ +

Returns the profile data.

+
+
+

Details

-

-
at line 21
- public String - name() +
+
+

+
at line 21
+ string + name() +

-

Returns the name of the profile

-

-

-
+ + + +
+

Returns the name of the profile.

+

Return Value

- +
- - + +
String -string
@@ -83,24 +147,28 @@

Return Value

-

-
at line 28
- public String - data() +

+
+

+
at line 28
+ string + data() +

-

Returns the profile data

-

-

-
+ + + +
+

Returns the profile data.

+

Return Value

- +
- - + +
String -string
@@ -109,10 +177,17 @@

Return Value

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Image/namespace-frame.html b/docs/API/API/Imagine/Image/namespace-frame.html deleted file mode 100644 index 6a6b3ca16..000000000 --- a/docs/API/API/Imagine/Image/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Image | - - - diff --git a/docs/API/API/Imagine/Imagick.html b/docs/API/API/Imagine/Imagick.html index edee94b3b..80f3be926 100644 --- a/docs/API/API/Imagine/Imagick.html +++ b/docs/API/API/Imagine/Imagick.html @@ -1,60 +1,149 @@ - - - - Imagine\Imagick | - - - -
- - -
- -
Namespace
-

Imagine\Imagick

+ + + + Imagine\Imagick | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Imagick
  5. \
    6. +
+
+
+ +
+

Imagine\Imagick

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
DrawerDrawer implementation using the Imagick PHP extension
EffectsEffects implementation using the Imagick PHP extension
FontFont implementation using the Imagick PHP extension
ImageImage implementation using the Imagick PHP extension
ImagineImagine implementation using the Imagick PHP extension
Layers -
+ + +

Classes

+ +
+
+
+ Drawer + +
+
+ Drawer implementation using the Imagick PHP extension. +
+
+
+
+ Effects + +
+
+ Effects implementation using the Imagick PHP extension. +
+
+
+
+ Font + +
+
+ Font implementation using the Imagick PHP extension. +
+
+
+
+ Image + +
+
+ Image implementation using the Imagick PHP extension. +
+
+
+
+ Imagine + +
+
+ Imagine implementation using the Imagick PHP extension. +
+
+
+
+ Layers + +
+
+ +
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Imagick/Drawer.html b/docs/API/API/Imagine/Imagick/Drawer.html index 4e7642dfc..e45d000c5 100644 --- a/docs/API/API/Imagine/Imagick/Drawer.html +++ b/docs/API/API/Imagine/Imagick/Drawer.html @@ -1,728 +1,1051 @@ - - - - Imagine\Imagick\Drawer | - - - -
- - -
- -
Class
-

Imagine\Imagick\Drawer

+ + + + Imagine\Imagick\Drawer | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Imagick
  5. \
  6. Drawer
    7. +
+
+
+ +
+

+ Drawer + +

-
-

class + +

class Drawer implements - DrawerInterface

+ DrawerInterface +

+ + +
-

Drawer implementation using the Imagick PHP extension

-

-

-
+

Drawer implementation using the Imagick PHP extension.

+

Methods

- - - - - - + +
+ __construct(Imagick $imagick) + +

No description

+
+
+ +
+
+ $this +
+
+ arc(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, int $thickness = 1) + +

Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.

+
+
+
+
+ $this +
+
+ chord(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Same as arc, but also connects end points with a straight line.

+
+
+
+
+ $this +
+
+ circle(PointInterface $center, int $radius, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws and circle with center at the given x, y coordinates, and given radius.

+
+
+
+
+ $this +
+
+ ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws and ellipse with center at the given x, y coordinates, and given width and height.

+
+
+
+
+ $this +
+
+ line(PointInterface $start, PointInterface $end, ColorInterface $color, int $thickness = 1) + +

Draws a line from start(x, y) to end(x, y) coordinates.

+
+
+
+
+ $this +
+
+ pieSlice(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Same as arc, but connects end points and the center.

+
+
+
+
+ $this +
+
+ dot(PointInterface $position, ColorInterface $color) + +

Places a one pixel point at specific coordinates and fills it with +specified color.

+
+
+
+
+ $this +
+
+ rectangle(PointInterface $leftTop, PointInterface $rightBottom, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.

+
+
+
+
+ $this +
+
+ polygon(array $coordinates, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.

+
+
+
+
+ $this +
+
+ text(string $string, AbstractFont $font, PointInterface $position, int $angle = 0, int $width = null) + +

Annotates image with specified text at a given position starting on the top left of the final text box.

+
+
+ + + +

Details

+ +
+
+

+
at line 37
+ + __construct(Imagick $imagick) + +

+
+ + + +
+

Parameters

+ +
+
+
+
-
- __construct(Imagick $imagick) -

-

-
- - + + +
- DrawerInterface - - arc(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, integer $thickness = 1) -

Draws an arc on a starting at a given x, y coordinates under a given start and end angles

- 		Imagick$imagick
+ + + + +
+
+ +
+
+

+
at line 47
+ $this + arc(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, int $thickness = 1) + +

+
+ + + +
+

Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.

+
+

Parameters

+ + - - + + - - + + - - + + - - + + - - + + - - + + +
- DrawerInterface - - chord(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Same as arc, but also connects end points with a straight line

- 		PointInterface$center
- DrawerInterface - - ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Draws and ellipse with center at the given x, y coordinates, and given width and height

- 		BoxInterface$size
- DrawerInterface - - line(PointInterface $start, PointInterface $end, ColorInterface $color, integer $thickness = 1) -

Draws a line from start(x, y) to end(x, y) coordinates

- 		int$start
- DrawerInterface - - pieSlice(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Same as arc, but connects end points and the center

- 		int$end
- DrawerInterface - - dot(PointInterface $position, ColorInterface $color) -

Places a one pixel point at specific coordinates and fills it with specified color

- 		ColorInterface$color
- DrawerInterface - - polygon(array $coordinates, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) -

Draws a polygon using array of x, y coordinates.

- 		int$thickness
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + - - +
- DrawerInterface - - text(string $string, AbstractFont $font, PointInterface $position, integer $angle, integer $width = null) -

Annotates image with specified text at a given position starting on the top left of the final text box

- 		RuntimeException
+ +

See also

-

Details

- -

-
at line 36
- public - __construct(Imagick $imagick) -

-
-

-

-

-

-
-

Parameters

- - +
- - + DrawerInterface::arc + +
Imagick$imagick -
- - -
-

-
at line 44
- public DrawerInterface - arc(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, integer $thickness = 1) +

+
+

+
at line 86
+ $this + chord(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws an arc on a starting at a given x, y coordinates under a given start and end angles

-

-

-
+ + + +
+

Same as arc, but also connects end points with a straight line.

+

Parameters

- +
- + - + - + - + - + - + - + + + + + + - + - +
PointInterface $center -
BoxInterface $size -
integerint $start -
integerint $end -
ColorInterface $color -
bool$fill
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::chord +
+
-

-
at line 77
- public DrawerInterface - chord(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 141
+ $this + circle(PointInterface $center, int $radius, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Same as arc, but also connects end points with a straight line

-

-

-
+ + + +
+

Draws and circle with center at the given x, y coordinates, and given radius.

+

Parameters

- +
- - - - - - - - - - - + - - - + + + - + - + - + - + - +
PointInterface $center -
BoxInterface$size -
integer$start -
integer$end -int$radius
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::circle +
+
-

-
at line 129
- public DrawerInterface - ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 153
+ $this + ellipse(PointInterface $center, BoxInterface $size, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws and ellipse with center at the given x, y coordinates, and given width and height

-

-

-
+ + + +
+

Draws and ellipse with center at the given x, y coordinates, and given width and height.

+

Parameters

- +
- + - + - + - + - + - + - +
PointInterface $center -
BoxInterface $size -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::ellipse +
+
-

-
at line 174
- public DrawerInterface - line(PointInterface $start, PointInterface $end, ColorInterface $color, integer $thickness = 1) +

+
+

+
at line 203
+ $this + line(PointInterface $start, PointInterface $end, ColorInterface $color, int $thickness = 1) +

-

Draws a line from start(x, y) to end(x, y) coordinates

-

-

-
+ + + +
+

Draws a line from start(x, y) to end(x, y) coordinates.

+

Parameters

- +
- + - + - + - + - +
PointInterface $start -
PointInterface $end -
ColorInterface $color -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this
+

See also

+ + + + + + +
+ DrawerInterface::line +
+
-

-
at line 207
- public DrawerInterface - pieSlice(PointInterface $center, BoxInterface $size, integer $start, integer $end, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 242
+ $this + pieSlice(PointInterface $center, BoxInterface $size, int $start, int $end, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Same as arc, but connects end points and the center

-

-

-
+ + + +
+

Same as arc, but connects end points and the center.

+

Parameters

- +
- + - + - + - + - + - + - + - + - + - + - +
PointInterface $center -
BoxInterface $size -
integerint $start -
integerint $end -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::pieSlice +
+
-

-
at line 241
- public DrawerInterface - dot(PointInterface $position, ColorInterface $color) +

+
+

+
at line 282
+ $this + dot(PointInterface $position, ColorInterface $color) +

-

Places a one pixel point at specific coordinates and fills it with specified color

-

-

-
+ + + +
+

Places a one pixel point at specific coordinates and fills it with +specified color.

+

Parameters

- +
- + - +
PointInterface $position -
ColorInterface $color -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
+ + + + +
RuntimeException
+ + +

See also

+ + - + DrawerInterface::dot + +
RuntimeException -
+
+
+ +
+
+

+
at line 313
+ $this + rectangle(PointInterface $leftTop, PointInterface $rightBottom, ColorInterface $color, bool $fill = false, int $thickness = 1) + +

+
+ + +
+

Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.

+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
PointInterface$leftTop
PointInterface$rightBottom
ColorInterface$color
bool$fill
int$thickness
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +

See also

+ + + + + + +
+ DrawerInterface::rectangle +
+
-

-
at line 270
- public DrawerInterface - polygon(array $coordinates, ColorInterface $color, Boolean $fill = false, integer $thickness = 1) +

+
+

+
at line 356
+ $this + polygon(array $coordinates, ColorInterface $color, bool $fill = false, int $thickness = 1) +

-

Draws a polygon using array of x, y coordinates.

-

Must contain at least -three coordinates

-
+ + + +
+

Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.

+

Parameters

- +
- + - + - + - + - + - +
array $coordinates -
ColorInterface $color -
Booleanbool $fill -
integerint $thickness -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::polygon +
+
-

-
at line 311
- public DrawerInterface - text(string $string, AbstractFont $font, PointInterface $position, integer $angle, integer $width = null) +

+
+

+
at line 403
+ $this + text(string $string, AbstractFont $font, PointInterface $position, int $angle = 0, int $width = null) +

-

Annotates image with specified text at a given position starting on the top left of the final text box

-

The rotation is done CW

-
+ + + +
+

Annotates image with specified text at a given position starting on the top left of the final text box.

The rotation is done CW

+

Parameters

- +
- + - + - + - + - + - + - +
string $string -
AbstractFont $font -
PointInterface $position -
integerint $angle -
integerint $width -

Return Value

- +
- - + +
DrawerInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ DrawerInterface::text +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Imagick/Effects.html b/docs/API/API/Imagine/Imagick/Effects.html index e46798a1f..3f2e12bcf 100644 --- a/docs/API/API/Imagine/Imagick/Effects.html +++ b/docs/API/API/Imagine/Imagick/Effects.html @@ -1,138 +1,217 @@ - - - - Imagine\Imagick\Effects | - - - -
- - -
- -
Class
-

Imagine\Imagick\Effects

+ + + + Imagine\Imagick\Effects | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class + +

+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Imagick
  5. \
  6. Effects
    7. +
+
+
+ +
+

+ Effects + +

+
+ +

class Effects implements - EffectsInterface

+ EffectsInterface +

+ + +
-

Effects implementation using the Imagick PHP extension

-

-

-
+

Effects implementation using the Imagick PHP extension.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+
+
-
- __construct(Imagick $imagick) -

-

-
- EffectsInterface - + +
+ __construct(Imagick $imagick) + +

Initialize the instance.

+
+ +
+
+ $this +
+
gamma(float $correction) -

Apply gamma correction

-
- EffectsInterface - + +

Apply gamma correction.

+
+ +
+
+ $this +
+
negative() -

Invert the colors of the image

-
- EffectsInterface - + +

Invert the colors of the image.

+
+ +
+
+ $this +
+
grayscale() -

Grayscale the image

-
- EffectsInterface - + +

Grayscale the image.

+
+ +
+
+ $this +
+
colorize(ColorInterface $color) -

Colorize the image

-
- EffectsInterface - + +

Colorize the image.

+
+ +
+
+ $this +
+
sharpen() -

Sharpens the image

-
- EffectsInterface - + +

Sharpens the image.

+
+ +
+
+ $this +
+
blur(float|int $sigma = 1) -

Blur the image

-
+ +

Blur the image.

+
+
+
+
+ $this +
+
+ brightness(int $brightness) + +

Changes the brightness of the image.

+
+
+
+
+ $this +
+
+ convolve(Matrix $matrix) + +

Convolves the image.

+
+
+

Details

-

-
at line 25
- public - __construct(Imagick $imagick) +
+
+

+
at line 37
+ + __construct(Imagick $imagick) +

-

-

-

-

-
+ + + +
+

Initialize the instance.

+

Parameters

- +
- + - +
ImagickImagick $imagick -
@@ -142,259 +221,467 @@

Parameters

-

-
at line 33
- public EffectsInterface - gamma(float $correction) +

+
+

+
at line 47
+ $this + gamma(float $correction) +

-

Apply gamma correction

-

-

-
+ + + +
+

Apply gamma correction.

+

Parameters

- +
- +
float $correction -

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::gamma +
+
-

-
at line 47
- public EffectsInterface - negative() +

+
+

+
at line 63
+ $this + negative() +

-

Invert the colors of the image

-

-

-
+ + + +
+

Invert the colors of the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::negative +
+
-

-
at line 61
- public EffectsInterface - grayscale() +

+
+

+
at line 79
+ $this + grayscale() +

-

Grayscale the image

-

-

-
+ + + +
+

Grayscale the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::grayscale +
+
-

-
at line 75
- public EffectsInterface - colorize(ColorInterface $color) +

+
+

+
at line 95
+ $this + colorize(ColorInterface $color) +

-

Colorize the image

-

-

-
+ + + +
+

Colorize the image.

+

Parameters

- +
- +
ColorInterface $color -

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::colorize +
+
-

-
at line 89
- public EffectsInterface - sharpen() +

+
+

+
at line 115
+ $this + sharpen() +

-

Sharpens the image

-

-

-
+ + + +
+

Sharpens the image.

+

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::sharpen +
+
-

-
at line 103
- public EffectsInterface - blur(float|int $sigma = 1) +

+
+

+
at line 131
+ $this + blur(float|int $sigma = 1) +

-

Blur the image

-

-

-
+ + + +
+

Blur the image.

+

Parameters

- +
+ + +
float|int $sigma
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + + + +
RuntimeException
+ + +

See also

+ + + + EffectsInterface::blur + + + +
-
+ +
+
+ +
+
+

+
at line 147
+ $this + brightness(int $brightness) + +

+
+ + + +
+

Changes the brightness of the image.

+
+

Parameters

+ + + + + +
int$brightnessThe level of brightness (-100 (black) to 100 (white))

Return Value

- +
- - + +
EffectsInterface -$this

Exceptions

- +
+ + + + +
RuntimeException
+ + +

See also

+ + - + EffectsInterface::brightness + + + +
RuntimeException -
+ +
+
+ +
+
+

+
at line 176
+ $this + convolve(Matrix $matrix) + +

+
+ + + +
+

Convolves the image.

+
+

Parameters

+ + + + + + + +
Matrix$matrixThe matrix from which derive the convolution kernel
+ + +

Return Value

+ + + + + + +
$this
+ + +

Exceptions

+ + + + +
RuntimeException
+

See also

+ + + + + + +
+ EffectsInterface::convolve +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Imagick/Font.html b/docs/API/API/Imagine/Imagick/Font.html index 809f52a95..e05cf0627 100644 --- a/docs/API/API/Imagine/Imagick/Font.html +++ b/docs/API/API/Imagine/Imagick/Font.html @@ -1,135 +1,249 @@ - - - - Imagine\Imagick\Font | - - - -
- - -
- -
Class
-

Imagine\Imagick\Font

+ + + + Imagine\Imagick\Font | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Font extends AbstractFont

-
-

Font implementation using the Imagick PHP extension

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Imagick
  5. \
  6. Font
    7. +
+
+
+ +
+

+ Font + +

+
+ +

class + Font extends AbstractFont +

+ + + +
+

Font implementation using the Imagick PHP extension.

-

Methods

+ +

Properties

- +
- - - + + + - - - + + + - - - + + + - -
- - - __construct(Imagick $imagick, string $file, integer $size, ColorInterface $color) -

-

+ 		+ protected string $filefrom AbstractFont
- string + + protected int - getFile() -

Gets the fontfile for current font

- 		from AbstractFont$sizefrom AbstractFont
- integer + + protected ColorInterface - getSize() -

Gets font's integer point size

- 		from AbstractFont$colorfrom AbstractFont
+
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(Imagick $imagick, string $file, int $size, ColorInterface $color) + +

No description

+
+
+
+
+
+ string +
+
+ getFile() + +

Gets the fontfile for current font.

+
from AbstractFont
+
+
+
+ int +
+
+ getSize() + +

Gets font's integer point size.

+
from AbstractFont
+
+
+
ColorInterface - - +
+
getColor() -

Gets font's color

- - from AbstractFont - - - + +

Gets font's color.

+
from AbstractFont
+
+
+
+ string +
+
+ wrapText(string $string, int $maxWidth, int $angle = 0) + +

Split a string into multiple lines so that it fits a specific width.

+
from AbstractFont
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractFont
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractFont
+
+
+
BoxInterface - - - box(string $string, integer $angle) -

Gets BoxInterface of font size on the image based on string and angle

- - - - +
+
+ box(string $string, int $angle = 0) + +

Gets BoxInterface of font size on the image based on string and angle.

+
+
+

Details

-

-
at line 34
- public - __construct(Imagick $imagick, string $file, integer $size, ColorInterface $color) +
+
+

+
at line 33
+ + __construct(Imagick $imagick, string $file, int $size, ColorInterface $color) +

-

-

-

-

-
+ + + +

Parameters

- +
- + - + - + - + - + - +
ImagickImagick $imagick -
string $file -
integerint $size -
ColorInterface $color -
@@ -139,131 +253,349 @@

Parameters

-

-
in AbstractFont at line 55
- final public string - getFile() +

+
+

+
in AbstractFont at line 66
+ final string + getFile() +

-

Gets the fontfile for current font

-

-

-
+ + + +
+

Gets the fontfile for current font.

+

Return Value

- +
- +
string -
+

See also

+ + + + + + +
+ FontInterface::getFile +
+
-

-
in AbstractFont at line 63
- final public integer - getSize() +

+
+

+
in AbstractFont at line 76
+ final int + getSize() +

-

Gets font's integer point size

-

-

-
+ + + +
+

Gets font's integer point size.

+

Return Value

- +
- - + +
integer -int
+

See also

+ + + + + + +
+ FontInterface::getSize +
+
-

-
in AbstractFont at line 71
- final public ColorInterface - getColor() +

+
+

+
in AbstractFont at line 86
+ final ColorInterface + getColor() +

-

Gets font's color

-

-

-
+ + + +
+

Gets font's color.

+

Return Value

- +
- +
ColorInterface -
+

See also

+ + + + + + +
+ FontInterface::getColor +
+
-

-
at line 44
- public BoxInterface - box(string $string, integer $angle) +

+
+

+
in AbstractFont at line 96
+ string + wrapText(string $string, int $maxWidth, int $angle = 0) +

-

Gets BoxInterface of font size on the image based on string and angle

-

-

-
+ + + +
+

Split a string into multiple lines so that it fits a specific width.

+

Parameters

- +
- + + + + + + - + + + +
string $string -The text to be wrapped
int$maxWidthThe maximum width of the text
integerint $angle
+ + +

Return Value

+ + + + + + +
string
+ + + +

See also

+ + + + + + +
+ FontInterface::wrapText +
+ +
+
+ +
+
+

+
in AbstractFont at line 135
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+
+ +

Return Value

+ + + + + + +
ClassFactoryInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+ +
+
+ +
+
+

+
in AbstractFont at line 149
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + + + ClassFactoryAwareInterface::setClassFactory + + + +
-
+ +
+
+ +
+
+

+
at line 45
+ BoxInterface + box(string $string, int $angle = 0) + +

+
+ + + +
+

Gets BoxInterface of font size on the image based on string and angle.

+
+

Parameters

+ + + + + + + + + + +
string$string
int$angle

Return Value

- +
- +
BoxInterface -
+

See also

+ + + + + + +
+ FontInterface::box +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Imagick/Image.html b/docs/API/API/Imagine/Imagick/Image.html index d052d0861..32ecf60f3 100644 --- a/docs/API/API/Imagine/Imagick/Image.html +++ b/docs/API/API/Imagine/Imagick/Image.html @@ -1,498 +1,835 @@ - - - - Imagine\Imagick\Image | - - - -
- - -
- -
Class
-

Imagine\Imagick\Image

+ + + + Imagine\Imagick\Image | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Image extends AbstractImage

-
-

Image implementation using the Imagick PHP extension

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Imagick
  5. \
  6. Image
    7. +
+
+
+ +
+

+ Image + +

+
+ +

class + Image extends AbstractImage +

+ + + + +
+

Image implementation using the Imagick PHP extension.

-

Methods

+

Properties

- +
- - - + + + - - -
- ManipulatorInterface + + protected MetadataBag - thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) -

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

- 		from AbstractImage$metadatafrom AbstractImage
- MetadataInterface - +
+ + +

Methods

+ +
+
+
+ ManipulatorInterface +
+
+ thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
from AbstractImage
+
+
+
+ int[] +
+
+ getAllThumbnailModes() + +

Get all the available thumbnail modes.

+
from AbstractImage
+
+
+
+ array +
+
+ updateSaveOptions(array $options) + +

Updates a given array of save options for backward compatibility with legacy names.

+
from AbstractImage
+
+
+
+ MetadataBag +
+
metadata() -

Returns the Image's meta data

- - from AbstractImage - - - + +

Returns the Image's meta data.

+
from AbstractImage
+
+
+
- - +
+
__clone() -

Assures the metadata instance will be cloned, too

- - from AbstractImage - - - + +

Clones all the resources associated to this instance.

+
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractImage
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractImage
+
+
+
- - - __construct(Imagick $imagick, PaletteInterface $palette, MetadataBag $metadata) -

Constructs a new Image instance

- - - - - +
+
+ __construct(Imagick $imagick, PaletteInterface $palette, MetadataBag $metadata) + +

Constructs a new Image instance.

+
+
+
+
- - +
+
__destruct() -

Destroys allocated imagick resources

- - - - - - Imagick - - + +

Destroys allocated imagick resources.

+
+
+
+
+ Imagick +
+
getImagick() -

Returns the underlying \Imagick instance

- - - - - + +

Returns the underlying \Imagick instance.

+
+
+
+
ManipulatorInterface - - +
+
copy() -

Copies current source image into a new ImageInterface instance

- - - - - - ManipulatorInterface - - + +

Copies current source image into a new ImageInterface instance.

+
+
+
+
+ $this +
+
crop(PointInterface $start, BoxInterface $size) -

Crops a specified box out of the source image (modifies the source image) Returns cropped self

- - - - - - ManipulatorInterface - - + +

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+
+
+
+
+ $this +
+
flipHorizontally() -

Flips current image using horizontal axis

- - - - - - ManipulatorInterface - - + +

Flips current image using vertical axis.

+
+
+
+
+ $this +
+
flipVertically() -

Flips current image using vertical axis

- - - - - - ManipulatorInterface - - + +

Flips current image using horizontal axis.

+
+
+
+
+ $this +
+
strip() -

Remove all profiles and comments

- - - - - - ManipulatorInterface - - - paste(ImageInterface $image, PointInterface $start) -

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

- - - - - - ManipulatorInterface - - + +

Remove all profiles and comments.

+
+
+
+
+ $this +
+
+ paste(ImageInterface $image, PointInterface $start, int $alpha = 100) + +

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

+
+
+
+
+ $this +
+
resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) -

Resizes current image and returns self

- - - - - - ManipulatorInterface - - - rotate(integer $angle, ColorInterface $background = null) -

Rotates an image at the given angle.

- - - - - - ManipulatorInterface - - + +

Resizes current image and returns self.

+
+
+
+
+ $this +
+
+ rotate(int $angle, ColorInterface $background = null) + +

Rotates an image at the given angle.

+
+
+
+
+ $this +
+
save(string $path = null, array $options = array()) -

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

- - - - - - ManipulatorInterface - - + +

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

+
+
+
+
+ $this +
+
show(string $format, array $options = array()) -

Outputs the image content

- - - - - + +

Outputs the image content.

+
+
+
+
string - - +
+
get(string $format, array $options = array()) -

Returns the image content as a binary string

- - - - - - ImageInterface - - + +

Returns the image content as a binary string.

+
+
+
+
+ $this +
+
interlace(string $scheme) -

Enables or disables interlacing

- - - - - + +

Enables or disables interlacing.

+
+
+
+
string - - +
+
__toString() -

Returns the image content as a PNG binary string

- - - - - + +

Returns the image content as a PNG binary string.

+
+
+
+
DrawerInterface - - +
+
draw() -

Instantiates and returns a DrawerInterface instance for image drawing

- - - - - + +

Instantiates and returns a DrawerInterface instance for image drawing.

+
+
+
+
EffectsInterface - - +
+
effects() -

-

- - - - - + +

No description

+
+
+
+
+
BoxInterface - - +
+
getSize() -

Returns current image size

- - - - - - ManipulatorInterface - - + +

Returns current image size.

+
+
+
+
+ $this +
+
applyMask(ImageInterface $mask) -

Applies a given mask to current image's alpha channel

- - - - - + +

Applies a given mask to current image's alpha channel.

+
+
+
+
ImageInterface - - +
+
mask() -

Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified

- - - - - - ManipulatorInterface - - + +

Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.

+
+
+
+
+ $this +
+
fill(FillInterface $fill) -

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

- - - - - - array - - + +

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+
+
+
+
+ ColorInterface[] +
+
histogram() -

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances

- - - - - + +

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.

+
+
+
+
ColorInterface - - +
+
getColorAt(PointInterface $point) -

Returns color at specified positions of current image

- + +

Returns color at specified positions of current image.

+
+
+
+
+ ColorInterface +
+
+ pixelToColor(ImagickPixel $pixel) + +

Returns a color given a pixel, depending the Palette context.

+
+
+
+
+ LayersInterface +
+
+ layers() + +

Returns the image layers when applicable.

+
+
+
+
+ $this +
+
+ usePalette(PaletteInterface $palette) + +

Set a palette for the image. Useful to change colorspace.

+
+
+
+
+ PaletteInterface +
+
+ palette() + +

Return the current color palette.

+
+
+
+
+ $this +
+
+ profile(ProfileInterface $profile) + +

Applies a color profile on the Image.

+
+
+
+
+ Imagick +
+
+ cloneImagick() + +

Clone the Imagick resource of this instance.

+
+
+
+ + +

Details

+ +
+
+

+
in AbstractImage at line 36
+ ManipulatorInterface + thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) + +

+
+ + + +
+

Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.

+
+

Parameters

+ + + + + - - - + + + - - - + + + +
BoxInterface$size
- ColorInterface - - pixelToColor(ImagickPixel $pixel) -

Returns a color given a pixel, depending the Palette context

- 		int|string$settingsOne or more of the ManipulatorInterface::THUMBNAIL_ flags (joined with |). It may be a string for backward compatibility with old constant values that were strings.
- LayersInterface - - layers() -

Returns the image layers when applicable.

- 		string$filterThe filter to use for resizing, one of ImageInterface::FILTER_*
+ + +

Return Value

+ + + + + + +
ManipulatorInterface
+ + +

Exceptions

+ + - - + +
- ImageInterface - - usePalette(PaletteInterface $palette) -

Set a palette for the image.

- 		RuntimeException
+ + +

See also

+ + - - + +
- PaletteInterface - - palette() -

Return the current color palette

- 		+ ManipulatorInterface::thumbnail +
+ +
+
+ +
+
+

+
in AbstractImage at line 146
+ protected int[] + getAllThumbnailModes() + +

+
+ + + +
+

Get all the available thumbnail modes.

+
+ +

Return Value

+ + + + + + +
int[]
+ + + +
+
+ +
+
+

+
in AbstractImage at line 161
+ protected array + updateSaveOptions(array $options) + +

+
+ + + +
+

Updates a given array of save options for backward compatibility with legacy names.

+
+

Parameters

+ + - - + + + + +
- ImageInterface - - profile(ProfileInterface $profile) -

Applies a color profile on the Image

- 		array$options
+ + +

Return Value

+ + + + + + +
array
+ + + +
+
+ +
+
+

+
in AbstractImage at line 176
+ MetadataBag + metadata() + +

+
+ + + +
+

Returns the Image's meta data.

+
+ +

Return Value

+ + + + + + +
MetadataBag
+ + + +

See also

+ + + +
+ ImageInterface::metadata +
+
+
-

Details

- -

-
in AbstractImage at line 27
- public ManipulatorInterface - thumbnail(BoxInterface $size, string $mode = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
at line 94
+ + __clone() +

-

Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image

-

-

-
-

Parameters

+ + - - - - - - +
+

Clones all the resources associated to this instance.

+
+ + + +

See also

+ +
BoxInterface$size -
- - - - - - - + AbstractImage::__clone + +
string$mode -
string$filterThe filter to use for resizing, one of ImageInterface::FILTER_*
+
+
+ +
+
+

+
in AbstractImage at line 196
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+

Return Value

- +
- - + +
ManipulatorInterface -ClassFactoryInterface
-

Exceptions

+ +

See also

- +
- + ClassFactoryAwareInterface::getClassFactory + +
RuntimeException -
-
-

-
in AbstractImage at line 103
- public MetadataInterface - metadata() +

+
+

+
in AbstractImage at line 210
+ $this + setClassFactory(ClassFactoryInterface $classFactory) +

-

Returns the Image's meta data

-

-

-
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + + + +
ClassFactoryInterface$classFactory
+

Return Value

- +
- - + +
MetadataInterface -$this
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+
-

-
in AbstractImage at line 111
- public - __clone() +

+
+

+
at line 78
+ + __construct(Imagick $imagick, PaletteInterface $palette, MetadataBag $metadata) +

-

Assures the metadata instance will be cloned, too

-

-

-
- - -
-
+ -

-
at line 67
- public - __construct(Imagick $imagick, PaletteInterface $palette, MetadataBag $metadata) -

-
-

Constructs a new Image instance

-

-

-
+
+

Constructs a new Image instance.

+

Parameters

- +
- + - + - + - +
ImagickImagick $imagick -
PaletteInterface $palette -
MetadataBag $metadata -
@@ -502,40 +839,49 @@

Parameters

-

-
at line 82
- public - __destruct() +

+
+

+
at line 109
+ + __destruct() +

-

Destroys allocated imagick resources

-

-

-
+ + + +
+

Destroys allocated imagick resources.

+
-

-
at line 95
- public Imagick - getImagick() +

+
+

+
at line 122
+ Imagick + getImagick() +

-

Returns the underlying \Imagick instance

-

-

-
+ + + +
+

Returns the underlying \Imagick instance.

+

Return Value

- +
- - + +
Imagick -Imagick
@@ -544,513 +890,649 @@

Return Value

-

-
at line 103
- public ManipulatorInterface - copy() +

+
+

+
at line 132
+ ManipulatorInterface + copy() +

-

Copies current source image into a new ImageInterface instance

-

-

-
+ + + +
+

Copies current source image into a new ImageInterface instance.

+

Return Value

- +
- +
ManipulatorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::copy +
+
-

-
at line 121
- public ManipulatorInterface - crop(PointInterface $start, BoxInterface $size) +

+
+

+
at line 146
+ $this + crop(PointInterface $start, BoxInterface $size) +

-

Crops a specified box out of the source image (modifies the source image) Returns cropped self

-

-

-
+ + + +
+

Crops a specified box out of the source image (modifies the source image) +Returns cropped self.

+

Parameters

- +
- + - +
PointInterface $start -
BoxInterface $size -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + +
OutOfBoundsException -OutOfBoundsException
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::crop +
+
-

-
at line 141
- public ManipulatorInterface - flipHorizontally() +

+
+

+
at line 178
+ $this + flipHorizontally() +

-

Flips current image using horizontal axis

-

-

-
+ + + +
+

Flips current image using vertical axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::flipHorizontally +
+
-

-
at line 155
- public ManipulatorInterface - flipVertically() +

+
+

+
at line 194
+ $this + flipVertically() +

-

Flips current image using vertical axis

-

-

-
+ + + +
+

Flips current image using horizontal axis.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::flipVertically +
+
-

-
at line 169
- public ManipulatorInterface - strip() +

+
+

+
at line 210
+ $this + strip() +

-

Remove all profiles and comments

-

-

-
+ + + +
+

Remove all profiles and comments.

+

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::strip +
+
-

-
at line 184
- public ManipulatorInterface - paste(ImageInterface $image, PointInterface $start) +

+
+

+
at line 232
+ $this + paste(ImageInterface $image, PointInterface $start, int $alpha = 100) +

-

Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails

-

Returns source image

-
+ + + +
+

Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.

Returns source image

+

Parameters

- +
- + - + + + + + +
ImageInterface $image -
PointInterface $start -
int$alphaHow to paste the image, from 0 (fully transparent) to 100 (fully opaque)

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + + - - + + +
InvalidArgumentException -InvalidArgumentException
OutOfBoundsException -RuntimeException
+ + +

See also

+ + - + ManipulatorInterface::paste + +
RuntimeException -
-
-

-
at line 206
- public ManipulatorInterface - resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

+
+

+
at line 282
+ $this + resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED) +

-

Resizes current image and returns self

-

-

-
+ + + +
+

Resizes current image and returns self.

+

Parameters

- +
- + - +
BoxInterface $size -
string $filter -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::resize +
+
-

-
at line 220
- public ManipulatorInterface - rotate(integer $angle, ColorInterface $background = null) +

+
+

+
at line 306
+ $this + rotate(int $angle, ColorInterface $background = null) +

-

Rotates an image at the given angle.

-

Optional $background can be used to specify the fill color of the empty -area of rotated image.

-
+ + + +
+

Rotates an image at the given angle.

Optional $background can be used to specify the fill color of the empty +area of rotated image.

+

Parameters

- +
- + - + - +
integerint $angle -
ColorInterface $background -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::rotate +
+
-

-
at line 241
- public ManipulatorInterface - save(string $path = null, array $options = array()) +

+
+

+
at line 332
+ $this + save(string $path = null, array $options = array()) +

-

Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported

-

-

-
+ + + +
+

Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.

Please remark that bmp is supported by the GD driver only since PHP 7.2.

+

Parameters

- +
- + - +
string $path -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ManipulatorInterface::save +
+
-

-
at line 261
- public ManipulatorInterface - show(string $format, array $options = array()) +

+
+

+
at line 354
+ $this + show(string $format, array $options = array()) +

-

Outputs the image content

-

-

-
+ + + +
+

Outputs the image content.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
- - + +
ManipulatorInterface -$this
-

Exceptions

+

Exceptions

+ + + + + + +
RuntimeException
+ + +

See also

- +
- + ManipulatorInterface::show + +
RuntimeException -
-
-

-
at line 272
- public string - get(string $format, array $options = array()) +

+
+

+
at line 367
+ string + get(string $format, array $options = array()) +

-

Returns the image content as a binary string

-

-

-
+ + + +
+

Returns the image content as a binary string.

+

Parameters

- +
- + - +
string $format -
array $options -

Return Value

- +
@@ -1060,78 +1542,107 @@

Return Value

Exceptions

-
string binary
+
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::get +
+
-

-
at line 287
- public ImageInterface - interlace(string $scheme) +

+
+

+
at line 384
+ $this + interlace(string $scheme) +

-

Enables or disables interlacing

-

-

-
+ + + +
+

Enables or disables interlacing.

+

Parameters

- +
- +
string $scheme -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException When an unsupported Interface type is supplied
+

See also

+ + + + + + +
+ ImageInterface::interlace +
+
-

-
at line 337
- public string - __toString() +

+
+

+
at line 436
+ string + __toString() +

-

Returns the image content as a PNG binary string

-

-

-
+ + + +
+

Returns the image content as a PNG binary string.

+

Return Value

- +
@@ -1141,307 +1652,437 @@

Return Value

Exceptions

-
string binary
+
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::__toString +
+
-

-
at line 345
- public DrawerInterface - draw() +

+
+

+
at line 446
+ DrawerInterface + draw() +

-

Instantiates and returns a DrawerInterface instance for image drawing

-

-

-
+ + + +
+

Instantiates and returns a DrawerInterface instance for image drawing.

+

Return Value

- +
- +
DrawerInterface -
+

See also

+ + + + + + +
+ ImageInterface::draw +
+
-

-
at line 353
- public EffectsInterface - effects() +

+
+

+
at line 456
+ EffectsInterface + effects() +

-

-

-

-

-
+ + + +

Return Value

- +
- +
EffectsInterface -
+

See also

+ + + + + + +
+ ImageInterface::effects +
+
-

-
at line 361
- public BoxInterface - getSize() +

+
+

+
at line 466
+ BoxInterface + getSize() +

-

Returns current image size

-

-

-
+ + + +
+

Returns current image size.

+

Return Value

- +
- +
BoxInterface -
+

See also

+ + + + + + +
+ ImageInterface::getSize +
+
-

-
at line 376
- public ManipulatorInterface - applyMask(ImageInterface $mask) +

+
+

+
at line 486
+ $this + applyMask(ImageInterface $mask) +

-

Applies a given mask to current image's alpha channel

-

-

-
+ + + +
+

Applies a given mask to current image's alpha channel.

+

Parameters

- +
- +
ImageInterface $mask -

Return Value

- +
- - + +
ManipulatorInterface -$this
+

See also

+ + + + + + +
+ ManipulatorInterface::applyMask +
+
-

-
at line 409
- public ImageInterface - mask() +

+
+

+
at line 521
+ ImageInterface + mask() +

-

Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified

-

-

-
+ + + +
+

Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.

+

Return Value

- +
- +
ImageInterface -
+

See also

+ + + + + + +
+ ImageInterface::mask +
+
-

-
at line 426
- public ManipulatorInterface - fill(FillInterface $fill) +

+
+

+
at line 540
+ $this + fill(FillInterface $fill) +

-

Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image

-

-

-
+ + + +
+

Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.

+

Parameters

- +
- +
FillInterface $fill -

Return Value

- +
- - + +
ManipulatorInterface -$this
+

See also

+ + + + + + +
+ ManipulatorInterface::fill +
+
-

-
at line 455
- public array - histogram() +

+
+

+
at line 571
+ ColorInterface[] + histogram() +

-

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances

-

-

-
+ + + +
+

Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.

+

Return Value

- +
- - + +
array -ColorInterface[]
+

See also

+ + + + + + +
+ ImageInterface::histogram +
+
-

-
at line 473
- public ColorInterface - getColorAt(PointInterface $point) +

+
+

+
at line 591
+ ColorInterface + getColorAt(PointInterface $point) +

-

Returns color at specified positions of current image

-

-

-
+ + + +
+

Returns color at specified positions of current image.

+

Parameters

- +
- +
PointInterface $point -

Return Value

- +
- +
ColorInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::getColorAt +
+
-

-
at line 499
- public ColorInterface - pixelToColor(ImagickPixel $pixel) +

+
+

+
at line 617
+ ColorInterface + pixelToColor(ImagickPixel $pixel) +

-

Returns a color given a pixel, depending the Palette context

-

Note : this method is public for PHP 5.3 compatibility

-
+ + + +
+

Returns a color given a pixel, depending the Palette context.

Note : this method is public for PHP 5.3 compatibility

+

Parameters

- +
- + - +
ImagickPixelImagickPixel $pixel -

Return Value

- +
- +
ColorInterface -

Exceptions

- +
- +
InvalidArgumentExceptionInvalidArgumentException In case a unknown color is requested
@@ -1450,157 +2091,253 @@

Exceptions

-

-
at line 532
- public LayersInterface - layers() +

+
+

+
at line 652
+ LayersInterface + layers() +

-

Returns the image layers when applicable.

-

-

-
+ + + +
+

Returns the image layers when applicable.

+

Return Value

- +
- +
LayersInterface -

Exceptions

- +
- + - +
RuntimeExceptionRuntimeException In case the layer can not be returned
OutOfBoundsExceptionOutOfBoundsException In case the index is not a valid value
+

See also

+ + + + + + +
+ ImageInterface::layers +
+
-

-
at line 540
- public ImageInterface - usePalette(PaletteInterface $palette) +

+
+

+
at line 666
+ $this + usePalette(PaletteInterface $palette) +

-

Set a palette for the image.

-

Useful to change colorspace.

-
+ + + +
+

Set a palette for the image. Useful to change colorspace.

+

Parameters

- +
- +
PaletteInterface $palette -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImageInterface::usePalette +
+
-

-
at line 577
- public PaletteInterface - palette() +

+
+

+
at line 705
+ PaletteInterface + palette() +

-

Return the current color palette

-

-

-
+ + + +
+

Return the current color palette.

+

Return Value

- +
- +
PaletteInterface -
+

See also

+ + + + + + +
+ ImageInterface::palette +
+
-

-
at line 585
- public ImageInterface - profile(ProfileInterface $profile) +

+
+

+
at line 715
+ $this + profile(ProfileInterface $profile) +

-

Applies a color profile on the Image

-

-

-
+ + + +
+

Applies a color profile on the Image.

+

Parameters

- +
- +
ProfileInterface $profile -

Return Value

- +
- - + +
ImageInterface -$this

Exceptions

- +
+ + + + +
RuntimeException
+ + +

See also

+ + - + ImageInterface::profile + + + +
RuntimeException -
+ +
+
+ +
+
+

+
at line 1071
+ protected Imagick + cloneImagick() + +

+
+ + + +
+

Clone the Imagick resource of this instance.

+
+ +

Return Value

+ + + + + + +
Imagick
+ + +

Exceptions

+ + + + +
ImagickException
@@ -1608,10 +2345,17 @@

Exceptions

+
+
+
-
+ diff --git a/docs/API/API/Imagine/Imagick/Imagine.html b/docs/API/API/Imagine/Imagick/Imagine.html index 29dc3b9eb..42249ce52 100644 --- a/docs/API/API/Imagine/Imagick/Imagine.html +++ b/docs/API/API/Imagine/Imagick/Imagine.html @@ -1,215 +1,471 @@ - - - - Imagine\Imagick\Imagine | - - - -
- - -
- -
Class
-

Imagine\Imagick\Imagine

+ + + + Imagine\Imagick\Imagine | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Imagine extends AbstractImagine

-
-

Imagine implementation using the Imagick PHP extension

-

-

+
+
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Imagick
  5. \
  6. Imagine
    7. +
+
+
+ +
+

+ Imagine + +

+
+ +

class + Imagine extends AbstractImagine +

+ + + + +
+

Imagine implementation using the Imagick PHP extension.

+

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +

Loads an image from a resource $resource.

+
+ +
+
+ FontInterface +
+
+ font(string $file, int $size, ColorInterface $color) + +

Constructs a font with specified $file, $size and $color.

+
+
+ + + +

Details

+ +
+
+

+
in AbstractImagine at line 36
+ $this + setMetadataReader(MetadataReaderInterface $metadataReader) + +

+
+ + + +
+

Set the object to be used to read image metadata.

+
+

Parameters

+ +
- ImagineInterface - +
+
+
+ $this +
+
setMetadataReader(MetadataReaderInterface $metadataReader) -

-

-
from AbstractImagine
+ +

Set the object to be used to read image metadata.

+
from AbstractImagine
+ +
+
MetadataReaderInterface -
+ +
getMetadataReader() -

-

-
from AbstractImagine
+ +

Get the object to be used to read image metadata.

+
from AbstractImagine
+ +
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractImagine
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractImagine
+
+
+
+ string +
+
+ checkPath(string|object $path) + +

Checks a path that could be used with ImagineInterface::open and returns +a proper string.

+
from AbstractImagine
+
+
+
-
+ +
__construct() -

-

-
+ +

No description

+ +
+ +
+
ImageInterface -
- open(string $path) -

Opens an existing image from $path

-
+ +
+ open(string|LoaderInterface|mixed $path) + +

Opens an existing image from $path.

+
+ +
+
ImageInterface -
+ +
create(BoxInterface $size, ColorInterface $color = null) -

Creates a new empty image with an optional background color

-
+ +

Creates a new empty image with an optional background color.

+
+ +
+
ImageInterface -
+ +
load(string $string) -

Loads an image from a binary $string

-
+ +

Loads an image from a binary $string.

+
+ +
+
ImageInterface -
+ +
read(resource $resource) -

Loads an image from a resource $resource

-
+ + + +
MetadataReaderInterface$metadataReader
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + - - +
- FontInterface - - font(string $file, integer $size, ColorInterface $color) -

Constructs a font with specified $file, $size and $color

- 		+ ImagineInterface::setMetadataReader +
+
+
-

Details

+
+
+

+
in AbstractImagine at line 48
+ MetadataReaderInterface + getMetadataReader() + +

+
+ + -

-
in AbstractImagine at line 27
- public ImagineInterface - setMetadataReader(MetadataReaderInterface $metadataReader) +
+

Get the object to be used to read image metadata.

+
+ +

Return Value

+ + + + + + +
MetadataReaderInterface
+ + + +

See also

+ + + + + + +
+ ImagineInterface::getMetadataReader +
+ +
+

+ +
+
+

+
in AbstractImagine at line 62
+ $this + setClassFactory(ClassFactoryInterface $classFactory) +

-

-

-

-

-
+ + + +
+

Set the class factory instance to be used.

+

Parameters

- +
+ + + + + +
ClassFactoryInterface$classFactory
+ + +

Return Value

+ + + + + + +
$this
+ + + +

See also

+ + - - + ClassFactoryAwareInterface::setClassFactory + +
MetadataReaderInterface$metadataReader -
+
+
+ +
+
+

+
in AbstractImagine at line 74
+ ClassFactoryInterface + getClassFactory() + +

+
+ + + +
+

Get the class factory instance to be used.

+

Return Value

- +
- - + +
ImagineInterface -ClassFactoryInterface
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+
-

-
in AbstractImagine at line 37
- public MetadataReaderInterface - getMetadataReader() +

+
+

+
in AbstractImagine at line 93
+ protected string + checkPath(string|object $path) +

-

-

-

-

-
+ + + +
+

Checks a path that could be used with ImagineInterface::open and returns +a proper string.

+
+

Parameters

+ + + + + + + +
string|object$path
+

Return Value

- +
- - + +
MetadataReaderInterface -string
+

Exceptions

+ + + + + + +
InvalidArgumentExceptionin case the given path is invalid
+
-

-
at line 33
- public - __construct() +

+
+

+
at line 36
+ + __construct() +

-

-

-

-

-
+ + + +

Exceptions

- +
- - + +
RuntimeException -RuntimeException
@@ -217,257 +473,327 @@

Exceptions

-

-
at line 47
- public ImageInterface - open(string $path) +

+
+

+
at line 57
+ ImageInterface + open(string|LoaderInterface|mixed $path) +

-

Opens an existing image from $path

-

-

-
+ + + +
+

Opens an existing image from $path.

+

Parameters

- +
- + - +
stringstring|LoaderInterface|mixed $path -the file path, a LoaderInterface instance, or an object whose string representation is the image path

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::open +
+
-

-
at line 64
- public ImageInterface - create(BoxInterface $size, ColorInterface $color = null) +

+
+

+
at line 88
+ ImageInterface + create(BoxInterface $size, ColorInterface $color = null) +

-

Creates a new empty image with an optional background color

-

-

-
+ + + +
+

Creates a new empty image with an optional background color.

+

Parameters

- +
- + - +
BoxInterface $size -
ColorInterface $color -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + + - - + +
InvalidArgumentException -InvalidArgumentException
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::create +
+
-

-
at line 97
- public ImageInterface - load(string $string) +

+
+

+
at line 130
+ ImageInterface + load(string $string) +

-

Loads an image from a binary $string

-

-

-
+ + + +
+

Loads an image from a binary $string.

+

Parameters

- +
- +
string $string -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::load +
+
-

-
at line 114
- public ImageInterface - read(resource $resource) +

+
+

+
at line 149
+ ImageInterface + read(resource $resource) +

-

Loads an image from a resource $resource

-

-

-
+ + + +
+

Loads an image from a resource $resource.

+

Parameters

- +
- +
resource $resource -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ ImagineInterface::read +
+
-

-
at line 133
- public FontInterface - font(string $file, integer $size, ColorInterface $color) +

+
+

+
at line 172
+ FontInterface + font(string $file, int $size, ColorInterface $color) +

-

Constructs a font with specified $file, $size and $color

-

The font size is to be specified in points (e.g. 10pt means 10)

-
+ + + +
+

Constructs a font with specified $file, $size and $color.

The font size is to be specified in points (e.g. 10pt means 10)

+

Parameters

- +
- + - + - + - +
string $file -
integerint $size -
ColorInterface $color -

Return Value

- +
- +
FontInterface -
+

See also

+ + + + + + +
+ ImagineInterface::font +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Imagick/Layers.html b/docs/API/API/Imagine/Imagick/Layers.html index 3e730cddf..2db6ef3d0 100644 --- a/docs/API/API/Imagine/Imagick/Layers.html +++ b/docs/API/API/Imagine/Imagick/Layers.html @@ -1,515 +1,753 @@ - - - - Imagine\Imagick\Layers | - - - -
- - -
- -
Class
-

Imagine\Imagick\Layers

+ + + + Imagine\Imagick\Layers | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
-
-

class - Layers extends AbstractLayers

+
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Imagick
  5. \
  6. Layers
    7. +
+
+
+ +
+

+ Layers + +

+
+ +

class + Layers extends AbstractLayers +

+ + + + +

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- LayersInterface - +
+
+
+ $this +
+
add(ImageInterface $image) -

Adds an image at the end of the layers stack

-
from AbstractLayers
- LayersInterface - - set(integer $offset, ImageInterface $image) -

Set an image at offset

- 		from AbstractLayers
- LayersInterface - - remove(integer $offset) -

Removes the image at offset

- 		from AbstractLayers
+ +

Adds an image at the end of the layers stack.

+
from AbstractLayers
+ +
+
+ $this +
+
+ set(int $offset, ImageInterface $image) + +

Set an image at offset.

+
from AbstractLayers
+
+
+
+ $this +
+
+ remove(int $offset) + +

Removes the image at offset.

+
from AbstractLayers
+
+
+
ImageInterface -
- get(integer $offset) -

Returns the image at offset

- 		from AbstractLayers
- Boolean - - has(integer $offset) -

Returns true if a layer at offset is preset

- 		from AbstractLayers
+ +
+ get(int $offset) + +

Returns the image at offset.

+
from AbstractLayers
+ +
+
+ bool +
+
+ has(int $offset) + +

Returns true if a layer at offset is preset.

+
from AbstractLayers
+
+
+
+ $this +
+
+ setClassFactory(ClassFactoryInterface $classFactory) + +

Set the class factory instance to be used.

+
from AbstractLayers
+
+
+
+ ClassFactoryInterface +
+
+ getClassFactory() + +

Get the class factory instance to be used.

+
from AbstractLayers
+
+
+
-
- __construct(Image $image, PaletteInterface $palette, Imagick $resource) -

-

-
+ +
+ __construct(Image $image, PaletteInterface $palette, Imagick $resource, $initialOffset = 0) + +

No description

+
+
+ +
+
-
+ +
merge() -

Merge layers into the original objects

-
- LayersInterface - - animate(string $format, integer $delay, integer $loops) -

Animates layers

-
- - + +

Merge layers into the original objects.

+
+ +
+
+ $this +
+
+ animate(string $format, int $delay, int $loops) + +

Animates layers.

+
+
+
+
+ $this +
+
coalesce() -

Coalesce layers.

-
+ +

Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.

+
+ +
+
-
+ +
current() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
key() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
next() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
rewind() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
valid() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
count() -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetExists($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetGet($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetSet($offset, $image) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+ +
+
-
+ +
offsetUnset($offset) -

{@inheritdoc}

-
+ +

{@inheritdoc}

+
+
+

Details

-

-
in AbstractLayers at line 19
- public LayersInterface - add(ImageInterface $image) +
+
+

+
in AbstractLayers at line 30
+ $this + add(ImageInterface $image) +

-

Adds an image at the end of the layers stack

-

-

-
+ + + +
+

Adds an image at the end of the layers stack.

+

Parameters

- +
- +
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ LayersInterface::add +
+
-

-
in AbstractLayers at line 29
- public LayersInterface - set(integer $offset, ImageInterface $image) +

+
+

+
in AbstractLayers at line 42
+ $this + set(int $offset, ImageInterface $image) +

-

Set an image at offset

-

-

-
+ + + +
+

Set an image at offset.

+

Parameters

- +
- + - + - +
integerint $offset -
ImageInterface $image -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
OutOfBoundsException -OutOfBoundsException
+

See also

+ + + + + + +
+ LayersInterface::set +
+
-

-
in AbstractLayers at line 39
- public LayersInterface - remove(integer $offset) +

+
+

+
in AbstractLayers at line 54
+ $this + remove(int $offset) +

-

Removes the image at offset

-

-

-
+ + + +
+

Removes the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- - + +
LayersInterface -$this

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
+

See also

+ + + + + + +
+ LayersInterface::remove +
+
-

-
in AbstractLayers at line 49
- public ImageInterface - get(integer $offset) +

+
+

+
in AbstractLayers at line 66
+ ImageInterface + get(int $offset) +

-

Returns the image at offset

-

-

-
+ + + +
+

Returns the image at offset.

+

Parameters

- +
- + - +
integerint $offset -

Return Value

- +
- +
ImageInterface -

Exceptions

- +
- - + + - - + +
RuntimeException -RuntimeException
InvalidArgumentException -InvalidArgumentException
+

See also

+ + + + + + +
+ LayersInterface::get +
+
-

-
in AbstractLayers at line 57
- public Boolean - has(integer $offset) +

+
+

+
in AbstractLayers at line 76
+ bool + has(int $offset) +

-

Returns true if a layer at offset is preset

-

-

-
+ + + +
+

Returns true if a layer at offset is preset.

+

Parameters

- +
- + + + +
integerint $offset
+ + +

Return Value

+ + + + + + +
bool
+ + + +

See also

+ + + + LayersInterface::has + + + +
-
+ +
+
+ +
+
+

+
in AbstractLayers at line 86
+ $this + setClassFactory(ClassFactoryInterface $classFactory) + +

+
+ + + +
+

Set the class factory instance to be used.

+
+

Parameters

+ + + + + +
ClassFactoryInterface$classFactory

Return Value

- +
- - + +
Boolean -$this
+

See also

+ + + + + + +
+ ClassFactoryAwareInterface::setClassFactory +
+
-

-
at line 42
- public - __construct(Image $image, PaletteInterface $palette, Imagick $resource) +

+
+

+
in AbstractLayers at line 98
+ ClassFactoryInterface + getClassFactory() +

-

-

-

-

-
+ + + +
+

Get the class factory instance to be used.

+
+ +

Return Value

+ + + + + + +
ClassFactoryInterface
+ + + +

See also

+ + + + + + +
+ ClassFactoryAwareInterface::getClassFactory +
+ +
+
+ +
+
+

+
at line 49
+ + __construct(Image $image, PaletteInterface $palette, Imagick $resource, $initialOffset = 0) + +

+
+ + + +

Parameters

- +
- + - + - + - + + + + + +
Image $image -
PaletteInterface $palette -
ImagickImagick $resource -
$initialOffset
@@ -519,57 +757,77 @@

Parameters

-

-
at line 52
- public - merge() +

+
+

+
at line 62
+ + merge() +

-

Merge layers into the original objects

-

-

-
+ + + +
+

Merge layers into the original objects.

+

Exceptions

- +
- - + +
RuntimeException -RuntimeException
+

See also

+ + + + + + +
+ LayersInterface::merge +
+
-

-
at line 67
- public LayersInterface - animate(string $format, integer $delay, integer $loops) +

+
+

+
at line 79
+ $this + animate(string $format, int $delay, int $loops) +

-

Animates layers

-

-

-
+ + + +
+

Animates layers.

+

Parameters

- +
- + - + @@ -578,262 +836,469 @@

Parameters

Return Value

-
string $format The output output format
integerint $delay The delay in milliseconds between two frames
integerint $loops The number of loops, 0 means infinite
+
- - + +
LayersInterface -$this

Exceptions

- +
- + - +
InvalidArgumentExceptionInvalidArgumentException In case an invalid argument is provided
RuntimeExceptionRuntimeException In case the driver fails to animate
+

See also

+ + + + + + +
+ LayersInterface::animate +
+
-

-
at line 104
- public - coalesce() +

+
+

+
at line 118
+ $this + coalesce() +

-

Coalesce layers.

-

Each layer in the sequence is the same size as the first and composited with the next layer in -the sequence.

-
+ + +
+

Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.

+
+

Return Value

+ + + + + + +
$this
+ +

Exceptions

+ + + + + + +
NotSupportedException
+ + +

See also

+ + + + + + +
+ LayersInterface::coalesce +
+
-

-
at line 126
- public - current() +

+
+

+
at line 144
+ + current() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Iterator::current() +
+
-

-
at line 156
- public - key() +

+
+

+
at line 177
+ + key() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Iterator::key() +
+
-

-
at line 164
- public - next() +

+
+

+
at line 187
+ + next() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Iterator::next() +
+
-

-
at line 172
- public - rewind() +

+
+

+
at line 197
+ + rewind() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Iterator::rewind() +
+
-

-
at line 180
- public - valid() +

+
+

+
at line 207
+ + valid() +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+
+

See also

+ + + + + + +
+ \Iterator::valid() +
+
-

-
at line 188
- public - count() +

+
+

+
at line 217
+ + count() +

-

{@inheritdoc}

-

-

-
+ + +
+

{@inheritdoc}

+
+ +

See also

+ + + + + + +
+ \Countable::count() +
+
-

-
at line 200
- public - offsetExists($offset) +

+
+

+
at line 231
+ + offsetExists($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetExists() +
+
-

-
at line 208
- public - offsetGet($offset) +

+
+

+
at line 241
+ + offsetGet($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetGet() +
+
-

-
at line 216
- public - offsetSet($offset, $image) +

+
+

+
at line 251
+ + offsetSet($offset, $image) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- + - +
$offset -
$image -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetSet() +
+
-

-
at line 256
- public - offsetUnset($offset) +

+
+

+
at line 293
+ + offsetUnset($offset) +

-

{@inheritdoc}

-

-

-
+ + + +
+

{@inheritdoc}

+

Parameters

- +
- +
$offset -
+

See also

+ + + + + + +
+ \ArrayAccess::offsetUnset() +
+
+
+
+
-
+ diff --git a/docs/API/API/Imagine/Imagick/namespace-frame.html b/docs/API/API/Imagine/Imagick/namespace-frame.html deleted file mode 100644 index c1bfc69cf..000000000 --- a/docs/API/API/Imagine/Imagick/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Imagick | - - - diff --git a/docs/API/API/Imagine/Test.html b/docs/API/API/Imagine/Test.html deleted file mode 100644 index f1670833d..000000000 --- a/docs/API/API/Imagine/Test.html +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - Imagine\Test | - - - -
- - -
- -
Namespace
-

Imagine\Test

-
-
- - - - - -
ImagineTestCase -
- - -
- - - diff --git a/docs/API/API/Imagine/Test/Constraint.html b/docs/API/API/Imagine/Test/Constraint.html deleted file mode 100644 index 60a118c40..000000000 --- a/docs/API/API/Imagine/Test/Constraint.html +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - Imagine\Test\Constraint | - - - -
- - -
- -
Namespace
-

Imagine\Test\Constraint

-
-
- - - - - -
IsImageEqual -
- - -
- - - diff --git a/docs/API/API/Imagine/Test/Constraint/IsImageEqual.html b/docs/API/API/Imagine/Test/Constraint/IsImageEqual.html deleted file mode 100644 index 036b891f1..000000000 --- a/docs/API/API/Imagine/Test/Constraint/IsImageEqual.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - Imagine\Test\Constraint\IsImageEqual | - - - -
- - -
- -
Class
-

Imagine\Test\Constraint\IsImageEqual

-
-
-

class - IsImageEqual extends PHPUnit_Framework_Constraint

- - - - -

Methods

- - - - - - - - - - - - - - - - - -
- - - __construct(ImageInterface $value, float $delta = 0.1, integer $buckets = 4) -

-

-
- - - evaluate($other) -

{@inheritdoc}

-
- - - toString() -

{@inheritdoc}

-
- - -

Details

- -

-
at line 42
- public - __construct(ImageInterface $value, float $delta = 0.1, integer $buckets = 4) -

-
-

-

-

-

-
-

Parameters

- - - - - - - - - - - - - - - - - -
ImageInterface$value -
float$delta -
integer$buckets -
- - - -

Exceptions

- - - - - - -
InvalidArgumentException -
- - -
-
- -

-
at line 64
- public - evaluate($other) -

-
-

{@inheritdoc}

-

-

-
-

Parameters

- - - - - - - -
$other -
- - - - -
-
- -

-
at line 97
- public - toString() -

-
-

{@inheritdoc}

-

-

-
- - - -
-
- - -
- - - diff --git a/docs/API/API/Imagine/Test/Constraint/namespace-frame.html b/docs/API/API/Imagine/Test/Constraint/namespace-frame.html deleted file mode 100644 index 51af810a6..000000000 --- a/docs/API/API/Imagine/Test/Constraint/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Test\Constraint | - - - diff --git a/docs/API/API/Imagine/Test/ImagineTestCase.html b/docs/API/API/Imagine/Test/ImagineTestCase.html deleted file mode 100644 index 5a543dbf9..000000000 --- a/docs/API/API/Imagine/Test/ImagineTestCase.html +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - Imagine\Test\ImagineTestCase | - - - -
- - -
- -
Class
-

Imagine\Test\ImagineTestCase

-
-
-

class - ImagineTestCase extends PHPUnit_Framework_TestCase

- - -

Constants

- - - - - - -
HTTP_IMAGE -

-

-

-

-
- - - -

Methods

- - - - - - - -
- static  - - assertImageEquals(ImageInterface $expected, ImageInterface $actual, string $message = '', float $delta = 0.1, integer $buckets = 4) -

Asserts that two images are equal using color histogram comparison method

-
- - -

Details

- -

-
at line 29
- static public - assertImageEquals(ImageInterface $expected, ImageInterface $actual, string $message = '', float $delta = 0.1, integer $buckets = 4) -

-
-

Asserts that two images are equal using color histogram comparison method

-

-

-
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
ImageInterface$expected -
ImageInterface$actual -
string$message -
float$delta -
integer$buckets -
- - - - -
-
- - -
- - - diff --git a/docs/API/API/Imagine/Test/namespace-frame.html b/docs/API/API/Imagine/Test/namespace-frame.html deleted file mode 100644 index bfe6e5e7f..000000000 --- a/docs/API/API/Imagine/Test/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine\Test | - - - diff --git a/docs/API/API/Imagine/Utils.html b/docs/API/API/Imagine/Utils.html new file mode 100644 index 000000000..21302f0fb --- /dev/null +++ b/docs/API/API/Imagine/Utils.html @@ -0,0 +1,113 @@ + + + + + + Imagine\Utils | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. Namespace
    2. +
  2. Imagine
  3. \
  4. Utils
  5. \
    6. +
+
+
+ +
+

Imagine\Utils

+
+ + +

Classes

+ +
+
+
+ ErrorHandling + +
+
+ +
+
+
+
+ Matrix + +
+
+ +
+
+
+ + + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Utils/ErrorHandling.html b/docs/API/API/Imagine/Utils/ErrorHandling.html new file mode 100644 index 000000000..987ebb470 --- /dev/null +++ b/docs/API/API/Imagine/Utils/ErrorHandling.html @@ -0,0 +1,257 @@ + + + + + + Imagine\Utils\ErrorHandling | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Utils
  5. \
  6. ErrorHandling
    7. +
+
+
+ +
+

+ ErrorHandling + +

+
+ +

class + ErrorHandling +

+ + + + + + + + +

Methods

+ +
+
+
+ static mixed +
+
+ ignoring(int $flags, callable $callback) + +

Call a callback ignoring $flags warnings.

+
+
+
+
+ static mixed +
+
+ throwingRuntimeException(int $flags, callable $callback) + +

Call a callback and throws a RuntimeException if a $flags warning is thrown.

+
+
+
+ + +

Details

+ +
+
+

+
at line 32
+ static mixed + ignoring(int $flags, callable $callback) + +

+
+ + + +
+

Call a callback ignoring $flags warnings.

+
+

Parameters

+ + + + + + + + + + + + +
int$flagsThe flags to be ignored (eg E_WARNING | E_NOTICE)
callable$callbackThe callable to be called
+ + +

Return Value

+ + + + + + +
mixedReturns the result of $callback
+ + +

Exceptions

+ + + + + + + + + + +
ExceptionThrows an Exception if $callback throws an Exception
ThrowableThrows an Throwable if $callback throws an Throwable
+ + +
+
+ +
+
+

+
at line 68
+ static mixed + throwingRuntimeException(int $flags, callable $callback) + +

+
+ + + +
+

Call a callback and throws a RuntimeException if a $flags warning is thrown.

+
+

Parameters

+ + + + + + + + + + + + +
int$flagsThe flags to be intercepted (eg E_WARNING | E_NOTICE)
callable$callbackThe callable to be called
+ + +

Return Value

+ + + + + + +
mixedReturns the result of $callback
+ + +

Exceptions

+ + + + + + + + + + + + + + + + + + +
RuntimeException
RuntimeException
Exception
Throwable
+ + +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/Utils/Matrix.html b/docs/API/API/Imagine/Utils/Matrix.html new file mode 100644 index 000000000..fc4a13166 --- /dev/null +++ b/docs/API/API/Imagine/Utils/Matrix.html @@ -0,0 +1,574 @@ + + + + + + Imagine\Utils\Matrix | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. class
    2. +
  2. Imagine
  3. \
  4. Utils
  5. \
  6. Matrix
    7. +
+
+
+ +
+

+ Matrix + +

+
+ +

class + Matrix +

+ + + + + + + +

Properties

+ + + + + + + + + + + + + + + + + + + + +
+ protected int[]|float[] + $elementsThe array of elements.
+ protected int + $widthThe matrix width.
+ protected int + $heightThe matrix height.
+ + +

Methods

+ +
+
+
+ +
+
+ __construct(int $width, int $height, int[]|float[] $elements = array()) + +

The given $elements get arranged as follows: The elements will be set from left to right in a row until the +row is full. Then, the next line begins alike and so on.

+
+
+
+
+ int +
+
+ getWidth() + +

Get the matrix width.

+
+
+
+
+ int +
+
+ getHeight() + +

Get the matrix height.

+
+
+
+
+ +
+
+ setElementAt(int $x, int $y, int|float $value) + +

Set the value of a cell.

+
+
+
+
+ int|float +
+
+ getElementAt(int $x, int $y) + +

Get the value of a cell.

+
+
+
+
+ int[]|float[] +
+
+ getValueList() + +

Return all the matrix values, as a monodimensional array.

+
+
+
+
+ int[]|float[] +
+
+ getMatrix() + +

Return all the matrix values, as a bidimensional array (every array item contains the values of a row).

+
+
+
+
+ Matrix +
+
+ normalize() + +

Returns a new Matrix instance, representing the normalized value of this matrix.

+
+
+
+
+ int +
+
+ calculatePosition(int $x, int $y) + +

Calculate the offset position of a cell.

+
+
+
+ + +

Details

+ +
+
+

+
at line 50
+ + __construct(int $width, int $height, int[]|float[] $elements = array()) + +

+
+ + + +
+

The given $elements get arranged as follows: The elements will be set from left to right in a row until the +row is full. Then, the next line begins alike and so on.

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
int$widththe matrix width
int$heighthe matrix height
int[]|float[]$elementsthe matrix elements
+ + + +

Exceptions

+ + + + + + +
InvalidArgumentException
+ + +
+
+ +
+
+

+
at line 79
+ int + getWidth() + +

+
+ + + +
+

Get the matrix width.

+
+ +

Return Value

+ + + + + + +
int
+ + + +
+
+ +
+
+

+
at line 89
+ int + getHeight() + +

+
+ + + +
+

Get the matrix height.

+
+ +

Return Value

+ + + + + + +
int
+ + + +
+
+ +
+
+

+
at line 101
+ + setElementAt(int $x, int $y, int|float $value) + +

+
+ + + +
+

Set the value of a cell.

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
int$x
int$y
int|float$value
+ + + + +
+
+ +
+
+

+
at line 114
+ int|float + getElementAt(int $x, int $y) + +

+
+ + + +
+

Get the value of a cell.

+
+

Parameters

+ + + + + + + + + + + + +
int$x
int$y
+ + +

Return Value

+ + + + + + +
int|float
+ + + +
+
+ +
+
+

+
at line 124
+ int[]|float[] + getValueList() + +

+
+ + + +
+

Return all the matrix values, as a monodimensional array.

+
+ +

Return Value

+ + + + + + +
int[]|float[]
+ + + +
+
+ +
+
+

+
at line 134
+ int[]|float[] + getMatrix() + +

+
+ + + +
+

Return all the matrix values, as a bidimensional array (every array item contains the values of a row).

+
+ +

Return Value

+ + + + + + +
int[]|float[]
+ + + +
+
+ +
+
+

+
at line 144
+ Matrix + normalize() + +

+
+ + + +
+

Returns a new Matrix instance, representing the normalized value of this matrix.

+
+ +

Return Value

+ + + + + + +
Matrix
+ + + +
+
+ +
+
+

+
at line 169
+ protected int + calculatePosition(int $x, int $y) + +

+
+ + + +
+

Calculate the offset position of a cell.

+
+

Parameters

+ + + + + + + + + + + + +
int$x
int$y
+ + +

Return Value

+ + + + + + +
int
+ + +

Exceptions

+ + + + + + +
OutOfBoundsException
+ + +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/docs/API/API/Imagine/namespace-frame.html b/docs/API/API/Imagine/namespace-frame.html deleted file mode 100644 index fbcae6621..000000000 --- a/docs/API/API/Imagine/namespace-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - Imagine | - - - diff --git a/docs/API/API/SAMI_VERSION b/docs/API/API/SAMI_VERSION index 550209086..fc28f8ecd 100644 --- a/docs/API/API/SAMI_VERSION +++ b/docs/API/API/SAMI_VERSION @@ -1 +1 @@ -1.4-DEV \ No newline at end of file +4.0.14-DEV \ No newline at end of file diff --git a/docs/API/API/classes-frame.html b/docs/API/API/classes-frame.html deleted file mode 100644 index e70620cad..000000000 --- a/docs/API/API/classes-frame.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - All Classes | - - - diff --git a/docs/API/API/classes.html b/docs/API/API/classes.html index 5a28bd94a..ff89552ea 100644 --- a/docs/API/API/classes.html +++ b/docs/API/API/classes.html @@ -1,741 +1,948 @@ - - - - Classes | - - - -
- + + + + All Classes | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -

Classes

+ +
+
+
+ +
+ + +
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Imagine\Draw\DrawerInterface - - Interface for the drawer -
- Imagine\Effects\EffectsInterface - - Interface for the effects -
- Imagine\Exception\Exception - - Imagine-specific exception -
- Imagine\Exception\InvalidArgumentException - - Imagine-specific invalid argument exception -
- Imagine\Exception\NotSupportedException - - Should be used when a driver does not support an operation. -
- Imagine\Exception\OutOfBoundsException - - Imagine-specific out of bounds exception -
- Imagine\Exception\RuntimeException - - Imagine-specific runtime exception -
- Imagine\Filter\Advanced\Border - - A border filter -
- Imagine\Filter\Advanced\Canvas - - A canvas filter -
- Imagine\Filter\Advanced\Grayscale - - The Grayscale filter calculates the gray-value based on RGB. -
- Imagine\Filter\Advanced\OnPixelBased - - The OnPixelBased takes a callable, and for each pixel, this callable is called with the image (\Imagine\Image\ImageInterface) and the current point (\Imagine\Image\Point) -
- Imagine\Filter\Advanced\RelativeResize - - The RelativeResize filter allows images to be resized relative to their existing dimensions. -
- Imagine\Filter\Basic\ApplyMask - - An apply mask filter -
- Imagine\Filter\Basic\Autorotate - - Rotates an image automatically based on exif information. -
- Imagine\Filter\Basic\Copy - - A copy filter -
- Imagine\Filter\Basic\Crop - - A crop filter -
- Imagine\Filter\Basic\Fill - - A fill filter -
- Imagine\Filter\Basic\FlipHorizontally - - A "flip horizontally" filter -
- Imagine\Filter\Basic\FlipVertically - - A "flip vertically" filter -
- Imagine\Filter\Basic\Paste - - A paste filter -
- Imagine\Filter\Basic\Resize - - A resize filter -
- Imagine\Filter\Basic\Rotate - - A rotate filter -
- Imagine\Filter\Basic\Save - - A save filter -
- Imagine\Filter\Basic\Show - - A show filter -
- Imagine\Filter\Basic\Strip - - A strip filter -
- Imagine\Filter\Basic\Thumbnail - - A thumbnail filter -
- Imagine\Filter\Basic\WebOptimization - - A filter to render web-optimized images -
- Imagine\Filter\FilterInterface - - Interface for imagine filters -
- Imagine\Filter\ImagineAware - - ImagineAware base class -
- Imagine\Filter\Transformation - - A transformation filter -
- Imagine\Gd\Drawer - - Drawer implementation using the GD library -
- Imagine\Gd\Effects - - Effects implementation using the GD library -
- Imagine\Gd\Font - - Font implementation using the GD library -
- Imagine\Gd\Image - - Image implementation using the GD library -
- Imagine\Gd\Imagine - - Imagine implementation using the GD library -
- Imagine\Gd\Layers - - - -
- Imagine\Gmagick\Drawer - - Drawer implementation using the Gmagick PHP extension -
- Imagine\Gmagick\Effects - - Effects implementation using the Gmagick PHP extension -
- Imagine\Gmagick\Font - - Font implementation using the Gmagick PHP extension -
- Imagine\Gmagick\Image - - Image implementation using the Gmagick PHP extension -
- Imagine\Gmagick\Imagine - - Imagine implementation using the Gmagick PHP extension -
- Imagine\Gmagick\Layers - - - -
- Imagine\Image\AbstractFont - - Abstract font base class -
- Imagine\Image\AbstractImage - - -
- Imagine\Image\AbstractImagine - - - -
- Imagine\Image\AbstractLayers - - +
-
- Imagine\Image\Box - - A box implementation -
- Imagine\Image\BoxInterface - - Interface for a box -
- Imagine\Image\Fill\FillInterface - - Interface for the fill -
- Imagine\Image\Fill\Gradient\Horizontal - - Horizontal gradient fill -
- Imagine\Image\Fill\Gradient\Linear - - Linear gradient fill -
- Imagine\Image\Fill\Gradient\Vertical - - Vertical gradient fill -
- Imagine\Image\FontInterface - - The font interface -
- Imagine\Image\Histogram\Bucket - - Bucket histogram -
- Imagine\Image\Histogram\Range - - Range histogram -
- Imagine\Image\ImageInterface - - The image interface -
- Imagine\Image\ImagineInterface - - The imagine interface -
- Imagine\Image\LayersInterface - - The layers interface -
- Imagine\Image\ManipulatorInterface - - The manipulator interface -
- Imagine\Image\Metadata\AbstractMetadataReader - - + +
+ -
- Imagine\Image\Metadata\DefaultMetadataReader - - Default metadata reader -
- Imagine\Image\Metadata\ExifMetadataReader - - Metadata driven by Exif information -
- Imagine\Image\Metadata\MetadataBag - - An interface for Image Metadata -
- Imagine\Image\Metadata\MetadataReaderInterface - - +
+
+

Classes

+
-
- Imagine\Image\Palette\CMYK - + +
+
+
+ DrawerInterface + +
+
+ Interface for the drawer. +
+
+
+
+ EffectsInterface + +
+
+ Interface for the effects. +
+
+
+
+ Exception + +
+
+ Imagine-specific exception. +
+
+
+
+ InvalidArgumentException + +
+
+ Imagine-specific invalid argument exception. +
+
+
+
+ NotSupportedException + +
+
+ Should be used when a driver does not support an operation. +
+
+
+
+ OutOfBoundsException + +
+
+ Imagine-specific out of bounds exception. +
+
+
+
+ RuntimeException + +
+
+ Imagine-specific runtime exception. +
+
+
+
+ ClassFactory + +
+
+ The default implementation of Imagine\Factory\ClassFactoryInterface. +
+
+
+
+ ClassFactoryAwareInterface + +
+
+ An interface that classes that accepts a class factory should implement. +
+
+
+
+ ClassFactoryInterface + +
+
+ The interface that class factories must implement. +
+
+
+
+ Loader + +
+
+ Default implementation of Imagine\File\LoaderInterface. +
+
+
+
+ LoaderInterface + +
+
+ Interface for classes that can load local or remote files. +
+
+
+
+ BlackWhite + +
+
+ This filter calculates, for each pixel of an image, whether it is ligher or darker than a threshold. +
+
+
+
+ Border + +
+
+ A border filter. +
+
+
+
+ BorderDetection + +
+
+ BorderDetection based on Laplace-Operator. Three different variants are offered:. +
+
+
+
+ Canvas + +
+
+ A canvas filter. +
+
+
+
+ Grayscale + +
+
+ The Grayscale filter calculates the gray-value based on RGB. +
+
+
+
+ Negation + +
+
+ This filter negates every color of every pixel of an image. +
+
+
+
+ Neighborhood + +
+
+ The Neighborhood filter takes a matrix and calculates the color current pixel based on its neighborhood. +
+
+
+
+ OnPixelBased + +
+
+ The OnPixelBased takes a callable, and for each pixel, this callable is called with the +image (\Imagine\Image\ImageInterface) and the current point (\Imagine\Image\Point). +
+
+
+
+ RelativeResize + +
+
+ The RelativeResize filter allows images to be resized relative to their existing dimensions. +
+
+
+
+ ApplyMask + +
+
+ An apply mask filter. +
+
+
+
+ Autorotate + +
+
+ Rotates an image automatically based on exif information. +
+
+
+
+ Copy + +
+
+ A copy filter. +
+
+
+
+ Crop + +
+
+ A crop filter. +
+
+
+
+ Fill + +
+
+ A fill filter. +
+
+
+
+ FlipHorizontally + +
+
+ A "flip horizontally" filter. +
+
+
+
+ FlipVertically + +
+
+ A "flip vertically" filter. +
+
+
+
+ Paste + +
+
+ A paste filter. +
+
+
+
+ Resize + +
+
+ A resize filter. +
+
+
+
+ Rotate + +
+
+ A rotate filter. +
+
+
+
+ Save + +
+
+ A save filter. +
+
+
+
+ Show + +
+
+ A show filter. +
+
+
+
+ Strip + +
+
+ A strip filter. +
+
+
+
+ Thumbnail + +
+
+ A thumbnail filter. +
+
+
+
+ WebOptimization + +
+
+ A filter to render web-optimized images. +
+
+
+
+ FilterInterface + +
+
+ Interface for imagine filters. +
+
+
+
+ ImagineAware + +
+
+ ImagineAware base class. +
+
+
+
+ Transformation + +
+
+ A transformation filter. +
+
+
+
+ Drawer + +
+
+ Drawer implementation using the GD PHP extension. +
+
+
+
+ Effects + +
+
+ Effects implementation using the GD PHP extension. +
+
+
+
+ Font + +
+
+ Font implementation using the GD library. +
+
+
+
+ Image + +
+
+ Image implementation using the GD library. +
+
+
+
+ Imagine + +
+
+ Imagine implementation using the GD library. +
+
+
+
+ Layers + +
+
- -
- Imagine\Image\Palette\ColorParser - + + +
+
+ Drawer + +
+
+ Drawer implementation using the Gmagick PHP extension. +
+
+
+
+ Effects + +
+
+ Effects implementation using the Gmagick PHP extension. +
+
+
+
+ Font + +
+
+ Font implementation using the Gmagick PHP extension. +
+
+
+
+ Image + +
+
+ Image implementation using the Gmagick PHP extension. +
+
+
+
+ Imagine + +
+
+ Imagine implementation using the Gmagick PHP extension. +
+
+
+
+ Layers + +
+
- -
- Imagine\Image\Palette\Color\CMYK - + + +
+
+ AbstractFont + +
+
+ Abstract font base class. +
+
+
+
+ AbstractImage + +
+
- -
- Imagine\Image\Palette\Color\ColorInterface - + + +
+
+ AbstractImagine + +
+
- -
- Imagine\Image\Palette\Color\Gray - + + +
+
+ AbstractLayers + +
+
- -
- Imagine\Image\Palette\Color\RGB - + + +
+
+ Box + +
+
+ A box implementation. +
+
+
+
+ BoxInterface + +
+
+ Interface for a box. +
+
+
+
+ FillInterface + +
+
+ Interface for the fill. +
+
+
+
+ Horizontal + +
+
+ Horizontal gradient fill. +
+
+
+
+ Linear + +
+
+ Linear gradient fill. +
+
+
+
+ Vertical + +
+
+ Vertical gradient fill. +
+
+
+
+ FontInterface + +
+
+ The font interface. +
+
+
+
+ Bucket + +
+
+ Bucket histogram. +
+
+
+
+ Range + +
+
+ Range histogram. +
+
+
+
+ ImageInterface + +
+
+ The image interface. +
+
+
+
+ ImagineInterface + +
+
+ The imagine interface. +
+
+
+
+ LayersInterface + +
+
+ The layers interface. +
+
+
+
+ ManipulatorInterface + +
+
+ The manipulator interface. +
+
+
+
+ AbstractMetadataReader + +
+
+ Base class for the default metadata readers. +
+
+
+
+ DefaultMetadataReader + +
+
+ A metadata reader that actually doesn't try to extract metadata. +
+
+
+
+ ExifMetadataReader + +
+
+ Metadata driven by Exif information. +
+
+
+
+ MetadataBag + +
+
+ The container of the data extracted from metadata. +
+
+
+
+ MetadataReaderInterface + +
+
+ Interface that metadata readers must implement. +
+
+
+
+ CMYK + +
+
+ The CMYK palette. +
+
+
+
+ ColorParser + +
+
- -
- Imagine\Image\Palette\Grayscale - + + +
+
+ CMYK + +
+
- -
- Imagine\Image\Palette\PaletteInterface - + + +
+
+ ColorInterface + +
+
- -
- Imagine\Image\Palette\RGB - + + +
+
+ Gray + +
+
- -
- Imagine\Image\Point - - The point class -
- Imagine\Image\PointInterface - - The point interface -
- Imagine\Image\Point\Center - - Point center -
- Imagine\Image\Profile - + + +
+
+ RGB + +
+
- -
- Imagine\Image\ProfileInterface - + + +
+
+ Grayscale + +
+
+ The grayscale palette. +
+
+
+
+ PaletteInterface + +
+
+ Interface that any palette must implement. +
+
+
+
+ RGB + +
+
+ The RGB palette. +
+
+
+
+ Point + +
+
+ The point class. +
+
+
+
+ PointInterface + +
+
+ The point interface. +
+
+
+
+ PointSigned + +
+
+ A point class that allows negative values of coordinates. +
+
+
+
+ Center + +
+
+ Center point of a box. +
+
+
+
+ Profile + +
+
+ The default implementation of ProfileInterface. +
+
+
+
+ ProfileInterface + +
+
- -
- Imagine\Imagick\Drawer - - Drawer implementation using the Imagick PHP extension -
- Imagine\Imagick\Effects - - Effects implementation using the Imagick PHP extension -
- Imagine\Imagick\Font - - Font implementation using the Imagick PHP extension -
- Imagine\Imagick\Image - - Image implementation using the Imagick PHP extension -
- Imagine\Imagick\Imagine - - Imagine implementation using the Imagick PHP extension -
- Imagine\Imagick\Layers - + + +
+
+ Drawer + +
+
+ Drawer implementation using the Imagick PHP extension. +
+
+
+
+ Effects + +
+
+ Effects implementation using the Imagick PHP extension. +
+
+
+
+ Font + +
+
+ Font implementation using the Imagick PHP extension. +
+
+
+
+ Image + +
+
+ Image implementation using the Imagick PHP extension. +
+
+
+
+ Imagine + +
+
+ Imagine implementation using the Imagick PHP extension. +
+
+
+
+ Layers + +
+
- -
- Imagine\Test\Constraint\IsImageEqual - + + +
+
+ ErrorHandling + +
+
- -
- Imagine\Test\ImagineTestCase - + + +
+
+ Matrix + +
+
+
+
+ + + -
- + diff --git a/docs/API/API/css/bootstrap-theme.min.css b/docs/API/API/css/bootstrap-theme.min.css new file mode 100644 index 000000000..7d213d933 --- /dev/null +++ b/docs/API/API/css/bootstrap-theme.min.css @@ -0,0 +1,10 @@ +/*! + * Bootstrap v3.3.1 (http://getbootstrap.com) + * Copyright 2011-2014 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + */ + +/*! + * Generated using the Bootstrap Customizer (http://getbootstrap.com/customize/?id=cb5a84c449e8302c563e) + * Config saved to config.json and https://gist.github.com/cb5a84c449e8302c563e + */.btn-default,.btn-primary,.btn-success,.btn-info,.btn-warning,.btn-danger{text-shadow:0 -1px 0 rgba(0,0,0,0.2);-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.15),0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 0 rgba(255,255,255,0.15),0 1px 1px rgba(0,0,0,0.075)}.btn-default:active,.btn-primary:active,.btn-success:active,.btn-info:active,.btn-warning:active,.btn-danger:active,.btn-default.active,.btn-primary.active,.btn-success.active,.btn-info.active,.btn-warning.active,.btn-danger.active{-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,0.125);box-shadow:inset 0 3px 5px rgba(0,0,0,0.125)}.btn-default .badge,.btn-primary .badge,.btn-success .badge,.btn-info .badge,.btn-warning .badge,.btn-danger .badge{text-shadow:none}.btn:active,.btn.active{background-image:none}.btn-default{background-image:-webkit-linear-gradient(top, #fff 0, #e0e0e0 100%);background-image:-o-linear-gradient(top, #fff 0, #e0e0e0 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #fff), to(#e0e0e0));background-image:linear-gradient(to bottom, #fff 0, #e0e0e0 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffffffff', endColorstr='#ffe0e0e0', GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);background-repeat:repeat-x;border-color:#dbdbdb;text-shadow:0 1px 0 #fff;border-color:#ccc}.btn-default:hover,.btn-default:focus{background-color:#e0e0e0;background-position:0 -15px}.btn-default:active,.btn-default.active{background-color:#e0e0e0;border-color:#dbdbdb}.btn-default:disabled,.btn-default[disabled]{background-color:#e0e0e0;background-image:none}.btn-primary{background-image:-webkit-linear-gradient(top, #428bca 0, #2d6ca2 100%);background-image:-o-linear-gradient(top, #428bca 0, #2d6ca2 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #428bca), to(#2d6ca2));background-image:linear-gradient(to bottom, #428bca 0, #2d6ca2 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff428bca', endColorstr='#ff2d6ca2', GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);background-repeat:repeat-x;border-color:#2b669a}.btn-primary:hover,.btn-primary:focus{background-color:#2d6ca2;background-position:0 -15px}.btn-primary:active,.btn-primary.active{background-color:#2d6ca2;border-color:#2b669a}.btn-primary:disabled,.btn-primary[disabled]{background-color:#2d6ca2;background-image:none}.btn-success{background-image:-webkit-linear-gradient(top, #5cb85c 0, #419641 100%);background-image:-o-linear-gradient(top, #5cb85c 0, #419641 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #5cb85c), to(#419641));background-image:linear-gradient(to bottom, #5cb85c 0, #419641 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff5cb85c', endColorstr='#ff419641', GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);background-repeat:repeat-x;border-color:#3e8f3e}.btn-success:hover,.btn-success:focus{background-color:#419641;background-position:0 -15px}.btn-success:active,.btn-success.active{background-color:#419641;border-color:#3e8f3e}.btn-success:disabled,.btn-success[disabled]{background-color:#419641;background-image:none}.btn-info{background-image:-webkit-linear-gradient(top, #5bc0de 0, #2aabd2 100%);background-image:-o-linear-gradient(top, #5bc0de 0, #2aabd2 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #5bc0de), to(#2aabd2));background-image:linear-gradient(to bottom, #5bc0de 0, #2aabd2 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff5bc0de', endColorstr='#ff2aabd2', GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);background-repeat:repeat-x;border-color:#28a4c9}.btn-info:hover,.btn-info:focus{background-color:#2aabd2;background-position:0 -15px}.btn-info:active,.btn-info.active{background-color:#2aabd2;border-color:#28a4c9}.btn-info:disabled,.btn-info[disabled]{background-color:#2aabd2;background-image:none}.btn-warning{background-image:-webkit-linear-gradient(top, #f0ad4e 0, #eb9316 100%);background-image:-o-linear-gradient(top, #f0ad4e 0, #eb9316 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #f0ad4e), to(#eb9316));background-image:linear-gradient(to bottom, #f0ad4e 0, #eb9316 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff0ad4e', endColorstr='#ffeb9316', GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);background-repeat:repeat-x;border-color:#e38d13}.btn-warning:hover,.btn-warning:focus{background-color:#eb9316;background-position:0 -15px}.btn-warning:active,.btn-warning.active{background-color:#eb9316;border-color:#e38d13}.btn-warning:disabled,.btn-warning[disabled]{background-color:#eb9316;background-image:none}.btn-danger{background-image:-webkit-linear-gradient(top, #d9534f 0, #c12e2a 100%);background-image:-o-linear-gradient(top, #d9534f 0, #c12e2a 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #d9534f), to(#c12e2a));background-image:linear-gradient(to bottom, #d9534f 0, #c12e2a 100%);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffd9534f', endColorstr='#ffc12e2a', GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);background-repeat:repeat-x;border-color:#b92c28}.btn-danger:hover,.btn-danger:focus{background-color:#c12e2a;background-position:0 -15px}.btn-danger:active,.btn-danger.active{background-color:#c12e2a;border-color:#b92c28}.btn-danger:disabled,.btn-danger[disabled]{background-color:#c12e2a;background-image:none}.thumbnail,.img-thumbnail{-webkit-box-shadow:0 1px 2px rgba(0,0,0,0.075);box-shadow:0 1px 2px rgba(0,0,0,0.075)}.dropdown-menu>li>a:hover,.dropdown-menu>li>a:focus{background-image:-webkit-linear-gradient(top, #f5f5f5 0, #e8e8e8 100%);background-image:-o-linear-gradient(top, #f5f5f5 0, #e8e8e8 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #f5f5f5), to(#e8e8e8));background-image:linear-gradient(to bottom, #f5f5f5 0, #e8e8e8 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff5f5f5', endColorstr='#ffe8e8e8', GradientType=0);background-color:#e8e8e8}.dropdown-menu>.active>a,.dropdown-menu>.active>a:hover,.dropdown-menu>.active>a:focus{background-image:-webkit-linear-gradient(top, #428bca 0, #357ebd 100%);background-image:-o-linear-gradient(top, #428bca 0, #357ebd 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #428bca), to(#357ebd));background-image:linear-gradient(to bottom, #428bca 0, #357ebd 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff428bca', endColorstr='#ff357ebd', GradientType=0);background-color:#357ebd}.navbar-default{background-image:-webkit-linear-gradient(top, #fff 0, #f8f8f8 100%);background-image:-o-linear-gradient(top, #fff 0, #f8f8f8 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #fff), to(#f8f8f8));background-image:linear-gradient(to bottom, #fff 0, #f8f8f8 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffffffff', endColorstr='#fff8f8f8', GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);border-radius:4px;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.15),0 1px 5px rgba(0,0,0,0.075);box-shadow:inset 0 1px 0 rgba(255,255,255,0.15),0 1px 5px rgba(0,0,0,0.075)}.navbar-default .navbar-nav>.open>a,.navbar-default .navbar-nav>.active>a{background-image:-webkit-linear-gradient(top, #dbdbdb 0, #e2e2e2 100%);background-image:-o-linear-gradient(top, #dbdbdb 0, #e2e2e2 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #dbdbdb), to(#e2e2e2));background-image:linear-gradient(to bottom, #dbdbdb 0, #e2e2e2 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffdbdbdb', endColorstr='#ffe2e2e2', GradientType=0);-webkit-box-shadow:inset 0 3px 9px rgba(0,0,0,0.075);box-shadow:inset 0 3px 9px rgba(0,0,0,0.075)}.navbar-brand,.navbar-nav>li>a{text-shadow:0 1px 0 rgba(255,255,255,0.25)}.navbar-inverse{background-image:-webkit-linear-gradient(top, #3c3c3c 0, #222 100%);background-image:-o-linear-gradient(top, #3c3c3c 0, #222 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #3c3c3c), to(#222));background-image:linear-gradient(to bottom, #3c3c3c 0, #222 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff3c3c3c', endColorstr='#ff222222', GradientType=0);filter:progid:DXImageTransform.Microsoft.gradient(enabled = false)}.navbar-inverse .navbar-nav>.open>a,.navbar-inverse .navbar-nav>.active>a{background-image:-webkit-linear-gradient(top, #080808 0, #0f0f0f 100%);background-image:-o-linear-gradient(top, #080808 0, #0f0f0f 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #080808), to(#0f0f0f));background-image:linear-gradient(to bottom, #080808 0, #0f0f0f 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff080808', endColorstr='#ff0f0f0f', GradientType=0);-webkit-box-shadow:inset 0 3px 9px rgba(0,0,0,0.25);box-shadow:inset 0 3px 9px rgba(0,0,0,0.25)}.navbar-inverse .navbar-brand,.navbar-inverse .navbar-nav>li>a{text-shadow:0 -1px 0 rgba(0,0,0,0.25)}.navbar-static-top,.navbar-fixed-top,.navbar-fixed-bottom{border-radius:0}@media (max-width:767px){.navbar .navbar-nav .open .dropdown-menu>.active>a,.navbar .navbar-nav .open .dropdown-menu>.active>a:hover,.navbar .navbar-nav .open .dropdown-menu>.active>a:focus{color:#fff;background-image:-webkit-linear-gradient(top, #428bca 0, #357ebd 100%);background-image:-o-linear-gradient(top, #428bca 0, #357ebd 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #428bca), to(#357ebd));background-image:linear-gradient(to bottom, #428bca 0, #357ebd 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff428bca', endColorstr='#ff357ebd', GradientType=0)}}.alert{text-shadow:0 1px 0 rgba(255,255,255,0.2);-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.25),0 1px 2px rgba(0,0,0,0.05);box-shadow:inset 0 1px 0 rgba(255,255,255,0.25),0 1px 2px rgba(0,0,0,0.05)}.alert-success{background-image:-webkit-linear-gradient(top, #dff0d8 0, #c8e5bc 100%);background-image:-o-linear-gradient(top, #dff0d8 0, #c8e5bc 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #dff0d8), to(#c8e5bc));background-image:linear-gradient(to bottom, #dff0d8 0, #c8e5bc 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffdff0d8', endColorstr='#ffc8e5bc', GradientType=0);border-color:#b2dba1}.alert-info{background-image:-webkit-linear-gradient(top, #d9edf7 0, #b9def0 100%);background-image:-o-linear-gradient(top, #d9edf7 0, #b9def0 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #d9edf7), to(#b9def0));background-image:linear-gradient(to bottom, #d9edf7 0, #b9def0 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffd9edf7', endColorstr='#ffb9def0', GradientType=0);border-color:#9acfea}.alert-warning{background-image:-webkit-linear-gradient(top, #fcf8e3 0, #f8efc0 100%);background-image:-o-linear-gradient(top, #fcf8e3 0, #f8efc0 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #fcf8e3), to(#f8efc0));background-image:linear-gradient(to bottom, #fcf8e3 0, #f8efc0 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fffcf8e3', endColorstr='#fff8efc0', GradientType=0);border-color:#f5e79e}.alert-danger{background-image:-webkit-linear-gradient(top, #f2dede 0, #e7c3c3 100%);background-image:-o-linear-gradient(top, #f2dede 0, #e7c3c3 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #f2dede), to(#e7c3c3));background-image:linear-gradient(to bottom, #f2dede 0, #e7c3c3 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff2dede', endColorstr='#ffe7c3c3', GradientType=0);border-color:#dca7a7}.progress{background-image:-webkit-linear-gradient(top, #ebebeb 0, #f5f5f5 100%);background-image:-o-linear-gradient(top, #ebebeb 0, #f5f5f5 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #ebebeb), to(#f5f5f5));background-image:linear-gradient(to bottom, #ebebeb 0, #f5f5f5 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffebebeb', endColorstr='#fff5f5f5', GradientType=0)}.progress-bar{background-image:-webkit-linear-gradient(top, #428bca 0, #3071a9 100%);background-image:-o-linear-gradient(top, #428bca 0, #3071a9 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #428bca), to(#3071a9));background-image:linear-gradient(to bottom, #428bca 0, #3071a9 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff428bca', endColorstr='#ff3071a9', GradientType=0)}.progress-bar-success{background-image:-webkit-linear-gradient(top, #5cb85c 0, #449d44 100%);background-image:-o-linear-gradient(top, #5cb85c 0, #449d44 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #5cb85c), to(#449d44));background-image:linear-gradient(to bottom, #5cb85c 0, #449d44 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff5cb85c', endColorstr='#ff449d44', GradientType=0)}.progress-bar-info{background-image:-webkit-linear-gradient(top, #5bc0de 0, #31b0d5 100%);background-image:-o-linear-gradient(top, #5bc0de 0, #31b0d5 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #5bc0de), to(#31b0d5));background-image:linear-gradient(to bottom, #5bc0de 0, #31b0d5 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff5bc0de', endColorstr='#ff31b0d5', GradientType=0)}.progress-bar-warning{background-image:-webkit-linear-gradient(top, #f0ad4e 0, #ec971f 100%);background-image:-o-linear-gradient(top, #f0ad4e 0, #ec971f 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #f0ad4e), to(#ec971f));background-image:linear-gradient(to bottom, #f0ad4e 0, #ec971f 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff0ad4e', endColorstr='#ffec971f', GradientType=0)}.progress-bar-danger{background-image:-webkit-linear-gradient(top, #d9534f 0, #c9302c 100%);background-image:-o-linear-gradient(top, #d9534f 0, #c9302c 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #d9534f), to(#c9302c));background-image:linear-gradient(to bottom, #d9534f 0, #c9302c 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffd9534f', endColorstr='#ffc9302c', GradientType=0)}.progress-bar-striped{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent)}.list-group{border-radius:4px;-webkit-box-shadow:0 1px 2px rgba(0,0,0,0.075);box-shadow:0 1px 2px rgba(0,0,0,0.075)}.list-group-item.active,.list-group-item.active:hover,.list-group-item.active:focus{text-shadow:0 -1px 0 #3071a9;background-image:-webkit-linear-gradient(top, #428bca 0, #3278b3 100%);background-image:-o-linear-gradient(top, #428bca 0, #3278b3 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #428bca), to(#3278b3));background-image:linear-gradient(to bottom, #428bca 0, #3278b3 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff428bca', endColorstr='#ff3278b3', GradientType=0);border-color:#3278b3}.list-group-item.active .badge,.list-group-item.active:hover .badge,.list-group-item.active:focus .badge{text-shadow:none}.panel{-webkit-box-shadow:0 1px 2px rgba(0,0,0,0.05);box-shadow:0 1px 2px rgba(0,0,0,0.05)}.panel-default>.panel-heading{background-image:-webkit-linear-gradient(top, #f5f5f5 0, #e8e8e8 100%);background-image:-o-linear-gradient(top, #f5f5f5 0, #e8e8e8 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #f5f5f5), to(#e8e8e8));background-image:linear-gradient(to bottom, #f5f5f5 0, #e8e8e8 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff5f5f5', endColorstr='#ffe8e8e8', GradientType=0)}.panel-primary>.panel-heading{background-image:-webkit-linear-gradient(top, #428bca 0, #357ebd 100%);background-image:-o-linear-gradient(top, #428bca 0, #357ebd 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #428bca), to(#357ebd));background-image:linear-gradient(to bottom, #428bca 0, #357ebd 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff428bca', endColorstr='#ff357ebd', GradientType=0)}.panel-success>.panel-heading{background-image:-webkit-linear-gradient(top, #dff0d8 0, #d0e9c6 100%);background-image:-o-linear-gradient(top, #dff0d8 0, #d0e9c6 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #dff0d8), to(#d0e9c6));background-image:linear-gradient(to bottom, #dff0d8 0, #d0e9c6 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffdff0d8', endColorstr='#ffd0e9c6', GradientType=0)}.panel-info>.panel-heading{background-image:-webkit-linear-gradient(top, #d9edf7 0, #c4e3f3 100%);background-image:-o-linear-gradient(top, #d9edf7 0, #c4e3f3 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #d9edf7), to(#c4e3f3));background-image:linear-gradient(to bottom, #d9edf7 0, #c4e3f3 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffd9edf7', endColorstr='#ffc4e3f3', GradientType=0)}.panel-warning>.panel-heading{background-image:-webkit-linear-gradient(top, #fcf8e3 0, #faf2cc 100%);background-image:-o-linear-gradient(top, #fcf8e3 0, #faf2cc 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #fcf8e3), to(#faf2cc));background-image:linear-gradient(to bottom, #fcf8e3 0, #faf2cc 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fffcf8e3', endColorstr='#fffaf2cc', GradientType=0)}.panel-danger>.panel-heading{background-image:-webkit-linear-gradient(top, #f2dede 0, #ebcccc 100%);background-image:-o-linear-gradient(top, #f2dede 0, #ebcccc 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #f2dede), to(#ebcccc));background-image:linear-gradient(to bottom, #f2dede 0, #ebcccc 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#fff2dede', endColorstr='#ffebcccc', GradientType=0)}.well{background-image:-webkit-linear-gradient(top, #e8e8e8 0, #f5f5f5 100%);background-image:-o-linear-gradient(top, #e8e8e8 0, #f5f5f5 100%);background-image:-webkit-gradient(linear, left top, left bottom, color-stop(0, #e8e8e8), to(#f5f5f5));background-image:linear-gradient(to bottom, #e8e8e8 0, #f5f5f5 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffe8e8e8', endColorstr='#fff5f5f5', GradientType=0);border-color:#dcdcdc;-webkit-box-shadow:inset 0 1px 3px rgba(0,0,0,0.05),0 1px 0 rgba(255,255,255,0.1);box-shadow:inset 0 1px 3px rgba(0,0,0,0.05),0 1px 0 rgba(255,255,255,0.1)} \ No newline at end of file diff --git a/docs/API/API/css/bootstrap.min.css b/docs/API/API/css/bootstrap.min.css new file mode 100644 index 000000000..a517ad7f1 --- /dev/null +++ b/docs/API/API/css/bootstrap.min.css @@ -0,0 +1,10 @@ +/*! + * Bootstrap v3.3.1 (http://getbootstrap.com) + * Copyright 2011-2014 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + */ + +/*! + * Generated using the Bootstrap Customizer (http://getbootstrap.com/customize/?id=cb5a84c449e8302c563e) + * Config saved to config.json and https://gist.github.com/cb5a84c449e8302c563e + *//*! normalize.css v3.0.2 | MIT License | git.io/normalize */html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}h1{font-size:2em;margin:0.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace, monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:0.35em 0.625em 0.75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:bold}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}/*! Source: https://github.com/h5bp/html5-boilerplate/blob/master/src/css/main.css */@media print{*,*:before,*:after{background:transparent !important;color:#000 !important;-webkit-box-shadow:none !important;box-shadow:none !important;text-shadow:none !important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="#"]:after,a[href^="javascript:"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}select{background:#fff !important}.navbar{display:none}.btn>.caret,.dropup>.btn>.caret{border-top-color:#000 !important}.label{border:1px solid #000}.table{border-collapse:collapse !important}.table td,.table th{background-color:#fff !important}.table-bordered th,.table-bordered td{border:1px solid #ddd !important}}@font-face{font-family:'Glyphicons Halflings';src:url('http://github.com/fonts/glyphicons-halflings-regular.eot');src:url('http://github.com/fonts/glyphicons-halflings-regular.eot?#iefix') format('embedded-opentype'),url('http://github.com/fonts/glyphicons-halflings-regular.woff') format('woff'),url('http://github.com/fonts/glyphicons-halflings-regular.ttf') format('truetype'),url('http://github.com/fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular') format('svg')}.glyphicon{position:relative;top:1px;display:inline-block;font-family:'Glyphicons Halflings';font-style:normal;font-weight:normal;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.glyphicon-asterisk:before{content:"\2a"}.glyphicon-plus:before{content:"\2b"}.glyphicon-euro:before,.glyphicon-eur:before{content:"\20ac"}.glyphicon-minus:before{content:"\2212"}.glyphicon-cloud:before{content:"\2601"}.glyphicon-envelope:before{content:"\2709"}.glyphicon-pencil:before{content:"\270f"}.glyphicon-glass:before{content:"\e001"}.glyphicon-music:before{content:"\e002"}.glyphicon-search:before{content:"\e003"}.glyphicon-heart:before{content:"\e005"}.glyphicon-star:before{content:"\e006"}.glyphicon-star-empty:before{content:"\e007"}.glyphicon-user:before{content:"\e008"}.glyphicon-film:before{content:"\e009"}.glyphicon-th-large:before{content:"\e010"}.glyphicon-th:before{content:"\e011"}.glyphicon-th-list:before{content:"\e012"}.glyphicon-ok:before{content:"\e013"}.glyphicon-remove:before{content:"\e014"}.glyphicon-zoom-in:before{content:"\e015"}.glyphicon-zoom-out:before{content:"\e016"}.glyphicon-off:before{content:"\e017"}.glyphicon-signal:before{content:"\e018"}.glyphicon-cog:before{content:"\e019"}.glyphicon-trash:before{content:"\e020"}.glyphicon-home:before{content:"\e021"}.glyphicon-file:before{content:"\e022"}.glyphicon-time:before{content:"\e023"}.glyphicon-road:before{content:"\e024"}.glyphicon-download-alt:before{content:"\e025"}.glyphicon-download:before{content:"\e026"}.glyphicon-upload:before{content:"\e027"}.glyphicon-inbox:before{content:"\e028"}.glyphicon-play-circle:before{content:"\e029"}.glyphicon-repeat:before{content:"\e030"}.glyphicon-refresh:before{content:"\e031"}.glyphicon-list-alt:before{content:"\e032"}.glyphicon-lock:before{content:"\e033"}.glyphicon-flag:before{content:"\e034"}.glyphicon-headphones:before{content:"\e035"}.glyphicon-volume-off:before{content:"\e036"}.glyphicon-volume-down:before{content:"\e037"}.glyphicon-volume-up:before{content:"\e038"}.glyphicon-qrcode:before{content:"\e039"}.glyphicon-barcode:before{content:"\e040"}.glyphicon-tag:before{content:"\e041"}.glyphicon-tags:before{content:"\e042"}.glyphicon-book:before{content:"\e043"}.glyphicon-bookmark:before{content:"\e044"}.glyphicon-print:before{content:"\e045"}.glyphicon-camera:before{content:"\e046"}.glyphicon-font:before{content:"\e047"}.glyphicon-bold:before{content:"\e048"}.glyphicon-italic:before{content:"\e049"}.glyphicon-text-height:before{content:"\e050"}.glyphicon-text-width:before{content:"\e051"}.glyphicon-align-left:before{content:"\e052"}.glyphicon-align-center:before{content:"\e053"}.glyphicon-align-right:before{content:"\e054"}.glyphicon-align-justify:before{content:"\e055"}.glyphicon-list:before{content:"\e056"}.glyphicon-indent-left:before{content:"\e057"}.glyphicon-indent-right:before{content:"\e058"}.glyphicon-facetime-video:before{content:"\e059"}.glyphicon-picture:before{content:"\e060"}.glyphicon-map-marker:before{content:"\e062"}.glyphicon-adjust:before{content:"\e063"}.glyphicon-tint:before{content:"\e064"}.glyphicon-edit:before{content:"\e065"}.glyphicon-share:before{content:"\e066"}.glyphicon-check:before{content:"\e067"}.glyphicon-move:before{content:"\e068"}.glyphicon-step-backward:before{content:"\e069"}.glyphicon-fast-backward:before{content:"\e070"}.glyphicon-backward:before{content:"\e071"}.glyphicon-play:before{content:"\e072"}.glyphicon-pause:before{content:"\e073"}.glyphicon-stop:before{content:"\e074"}.glyphicon-forward:before{content:"\e075"}.glyphicon-fast-forward:before{content:"\e076"}.glyphicon-step-forward:before{content:"\e077"}.glyphicon-eject:before{content:"\e078"}.glyphicon-chevron-left:before{content:"\e079"}.glyphicon-chevron-right:before{content:"\e080"}.glyphicon-plus-sign:before{content:"\e081"}.glyphicon-minus-sign:before{content:"\e082"}.glyphicon-remove-sign:before{content:"\e083"}.glyphicon-ok-sign:before{content:"\e084"}.glyphicon-question-sign:before{content:"\e085"}.glyphicon-info-sign:before{content:"\e086"}.glyphicon-screenshot:before{content:"\e087"}.glyphicon-remove-circle:before{content:"\e088"}.glyphicon-ok-circle:before{content:"\e089"}.glyphicon-ban-circle:before{content:"\e090"}.glyphicon-arrow-left:before{content:"\e091"}.glyphicon-arrow-right:before{content:"\e092"}.glyphicon-arrow-up:before{content:"\e093"}.glyphicon-arrow-down:before{content:"\e094"}.glyphicon-share-alt:before{content:"\e095"}.glyphicon-resize-full:before{content:"\e096"}.glyphicon-resize-small:before{content:"\e097"}.glyphicon-exclamation-sign:before{content:"\e101"}.glyphicon-gift:before{content:"\e102"}.glyphicon-leaf:before{content:"\e103"}.glyphicon-fire:before{content:"\e104"}.glyphicon-eye-open:before{content:"\e105"}.glyphicon-eye-close:before{content:"\e106"}.glyphicon-warning-sign:before{content:"\e107"}.glyphicon-plane:before{content:"\e108"}.glyphicon-calendar:before{content:"\e109"}.glyphicon-random:before{content:"\e110"}.glyphicon-comment:before{content:"\e111"}.glyphicon-magnet:before{content:"\e112"}.glyphicon-chevron-up:before{content:"\e113"}.glyphicon-chevron-down:before{content:"\e114"}.glyphicon-retweet:before{content:"\e115"}.glyphicon-shopping-cart:before{content:"\e116"}.glyphicon-folder-close:before{content:"\e117"}.glyphicon-folder-open:before{content:"\e118"}.glyphicon-resize-vertical:before{content:"\e119"}.glyphicon-resize-horizontal:before{content:"\e120"}.glyphicon-hdd:before{content:"\e121"}.glyphicon-bullhorn:before{content:"\e122"}.glyphicon-bell:before{content:"\e123"}.glyphicon-certificate:before{content:"\e124"}.glyphicon-thumbs-up:before{content:"\e125"}.glyphicon-thumbs-down:before{content:"\e126"}.glyphicon-hand-right:before{content:"\e127"}.glyphicon-hand-left:before{content:"\e128"}.glyphicon-hand-up:before{content:"\e129"}.glyphicon-hand-down:before{content:"\e130"}.glyphicon-circle-arrow-right:before{content:"\e131"}.glyphicon-circle-arrow-left:before{content:"\e132"}.glyphicon-circle-arrow-up:before{content:"\e133"}.glyphicon-circle-arrow-down:before{content:"\e134"}.glyphicon-globe:before{content:"\e135"}.glyphicon-wrench:before{content:"\e136"}.glyphicon-tasks:before{content:"\e137"}.glyphicon-filter:before{content:"\e138"}.glyphicon-briefcase:before{content:"\e139"}.glyphicon-fullscreen:before{content:"\e140"}.glyphicon-dashboard:before{content:"\e141"}.glyphicon-paperclip:before{content:"\e142"}.glyphicon-heart-empty:before{content:"\e143"}.glyphicon-link:before{content:"\e144"}.glyphicon-phone:before{content:"\e145"}.glyphicon-pushpin:before{content:"\e146"}.glyphicon-usd:before{content:"\e148"}.glyphicon-gbp:before{content:"\e149"}.glyphicon-sort:before{content:"\e150"}.glyphicon-sort-by-alphabet:before{content:"\e151"}.glyphicon-sort-by-alphabet-alt:before{content:"\e152"}.glyphicon-sort-by-order:before{content:"\e153"}.glyphicon-sort-by-order-alt:before{content:"\e154"}.glyphicon-sort-by-attributes:before{content:"\e155"}.glyphicon-sort-by-attributes-alt:before{content:"\e156"}.glyphicon-unchecked:before{content:"\e157"}.glyphicon-expand:before{content:"\e158"}.glyphicon-collapse-down:before{content:"\e159"}.glyphicon-collapse-up:before{content:"\e160"}.glyphicon-log-in:before{content:"\e161"}.glyphicon-flash:before{content:"\e162"}.glyphicon-log-out:before{content:"\e163"}.glyphicon-new-window:before{content:"\e164"}.glyphicon-record:before{content:"\e165"}.glyphicon-save:before{content:"\e166"}.glyphicon-open:before{content:"\e167"}.glyphicon-saved:before{content:"\e168"}.glyphicon-import:before{content:"\e169"}.glyphicon-export:before{content:"\e170"}.glyphicon-send:before{content:"\e171"}.glyphicon-floppy-disk:before{content:"\e172"}.glyphicon-floppy-saved:before{content:"\e173"}.glyphicon-floppy-remove:before{content:"\e174"}.glyphicon-floppy-save:before{content:"\e175"}.glyphicon-floppy-open:before{content:"\e176"}.glyphicon-credit-card:before{content:"\e177"}.glyphicon-transfer:before{content:"\e178"}.glyphicon-cutlery:before{content:"\e179"}.glyphicon-header:before{content:"\e180"}.glyphicon-compressed:before{content:"\e181"}.glyphicon-earphone:before{content:"\e182"}.glyphicon-phone-alt:before{content:"\e183"}.glyphicon-tower:before{content:"\e184"}.glyphicon-stats:before{content:"\e185"}.glyphicon-sd-video:before{content:"\e186"}.glyphicon-hd-video:before{content:"\e187"}.glyphicon-subtitles:before{content:"\e188"}.glyphicon-sound-stereo:before{content:"\e189"}.glyphicon-sound-dolby:before{content:"\e190"}.glyphicon-sound-5-1:before{content:"\e191"}.glyphicon-sound-6-1:before{content:"\e192"}.glyphicon-sound-7-1:before{content:"\e193"}.glyphicon-copyright-mark:before{content:"\e194"}.glyphicon-registration-mark:before{content:"\e195"}.glyphicon-cloud-download:before{content:"\e197"}.glyphicon-cloud-upload:before{content:"\e198"}.glyphicon-tree-conifer:before{content:"\e199"}.glyphicon-tree-deciduous:before{content:"\e200"}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}*:before,*:after{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:10px;-webkit-tap-highlight-color:rgba(0,0,0,0)}body{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;line-height:1.42857143;color:#333;background-color:#fff}input,button,select,textarea{font-family:inherit;font-size:inherit;line-height:inherit}a{color:#428bca;text-decoration:none}a:hover,a:focus{color:#2a6496;text-decoration:underline}a:focus{outline:thin dotted;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}figure{margin:0}img{vertical-align:middle}.img-responsive,.thumbnail>img,.thumbnail a>img,.carousel-inner>.item>img,.carousel-inner>.item>a>img{display:block;max-width:100%;height:auto}.img-rounded{border-radius:6px}.img-thumbnail{padding:4px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:all .2s ease-in-out;-o-transition:all .2s ease-in-out;transition:all .2s ease-in-out;display:inline-block;max-width:100%;height:auto}.img-circle{border-radius:50%}hr{margin-top:20px;margin-bottom:20px;border:0;border-top:1px solid #eee}.sr-only{position:absolute;width:1px;height:1px;margin:-1px;padding:0;overflow:hidden;clip:rect(0, 0, 0, 0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}h1,h2,h3,h4,h5,h6,.h1,.h2,.h3,.h4,.h5,.h6{font-family:inherit;font-weight:500;line-height:1.1;color:inherit}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small,.h1 small,.h2 small,.h3 small,.h4 small,.h5 small,.h6 small,h1 .small,h2 .small,h3 .small,h4 .small,h5 .small,h6 .small,.h1 .small,.h2 .small,.h3 .small,.h4 .small,.h5 .small,.h6 .small{font-weight:normal;line-height:1;color:#777}h1,.h1,h2,.h2,h3,.h3{margin-top:20px;margin-bottom:10px}h1 small,.h1 small,h2 small,.h2 small,h3 small,.h3 small,h1 .small,.h1 .small,h2 .small,.h2 .small,h3 .small,.h3 .small{font-size:65%}h4,.h4,h5,.h5,h6,.h6{margin-top:10px;margin-bottom:10px}h4 small,.h4 small,h5 small,.h5 small,h6 small,.h6 small,h4 .small,.h4 .small,h5 .small,.h5 .small,h6 .small,.h6 .small{font-size:75%}h1,.h1{font-size:36px}h2,.h2{font-size:30px}h3,.h3{font-size:24px}h4,.h4{font-size:18px}h5,.h5{font-size:14px}h6,.h6{font-size:12px}p{margin:0 0 10px}.lead{margin-bottom:20px;font-size:16px;font-weight:300;line-height:1.4}@media (min-width:768px){.lead{font-size:21px}}small,.small{font-size:85%}mark,.mark{background-color:#fcf8e3;padding:.2em}.text-left{text-align:left}.text-right{text-align:right}.text-center{text-align:center}.text-justify{text-align:justify}.text-nowrap{white-space:nowrap}.text-lowercase{text-transform:lowercase}.text-uppercase{text-transform:uppercase}.text-capitalize{text-transform:capitalize}.text-muted{color:#777}.text-primary{color:#428bca}a.text-primary:hover{color:#3071a9}.text-success{color:#3c763d}a.text-success:hover{color:#2b542c}.text-info{color:#31708f}a.text-info:hover{color:#245269}.text-warning{color:#8a6d3b}a.text-warning:hover{color:#66512c}.text-danger{color:#a94442}a.text-danger:hover{color:#843534}.bg-primary{color:#fff;background-color:#428bca}a.bg-primary:hover{background-color:#3071a9}.bg-success{background-color:#dff0d8}a.bg-success:hover{background-color:#c1e2b3}.bg-info{background-color:#d9edf7}a.bg-info:hover{background-color:#afd9ee}.bg-warning{background-color:#fcf8e3}a.bg-warning:hover{background-color:#f7ecb5}.bg-danger{background-color:#f2dede}a.bg-danger:hover{background-color:#e4b9b9}.page-header{padding-bottom:9px;margin:40px 0 20px;border-bottom:1px solid #eee}ul,ol{margin-top:0;margin-bottom:10px}ul ul,ol ul,ul ol,ol ol{margin-bottom:0}.list-unstyled{padding-left:0;list-style:none}.list-inline{padding-left:0;list-style:none;margin-left:-5px}.list-inline>li{display:inline-block;padding-left:5px;padding-right:5px}dl{margin-top:0;margin-bottom:20px}dt,dd{line-height:1.42857143}dt{font-weight:bold}dd{margin-left:0}@media (min-width:768px){.dl-horizontal dt{float:left;width:160px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.dl-horizontal dd{margin-left:180px}}abbr[title],abbr[data-original-title]{cursor:help;border-bottom:1px dotted #777}.initialism{font-size:90%;text-transform:uppercase}blockquote{padding:10px 20px;margin:0 0 20px;font-size:17.5px;border-left:5px solid #eee}blockquote p:last-child,blockquote ul:last-child,blockquote ol:last-child{margin-bottom:0}blockquote footer,blockquote small,blockquote .small{display:block;font-size:80%;line-height:1.42857143;color:#777}blockquote footer:before,blockquote small:before,blockquote .small:before{content:'\2014 \00A0'}.blockquote-reverse,blockquote.pull-right{padding-right:15px;padding-left:0;border-right:5px solid #eee;border-left:0;text-align:right}.blockquote-reverse footer:before,blockquote.pull-right footer:before,.blockquote-reverse small:before,blockquote.pull-right small:before,.blockquote-reverse .small:before,blockquote.pull-right .small:before{content:''}.blockquote-reverse footer:after,blockquote.pull-right footer:after,.blockquote-reverse small:after,blockquote.pull-right small:after,.blockquote-reverse .small:after,blockquote.pull-right .small:after{content:'\00A0 \2014'}address{margin-bottom:20px;font-style:normal;line-height:1.42857143}code,kbd,pre,samp{font-family:Menlo,Monaco,Consolas,"Courier New",monospace}code{padding:2px 4px;font-size:90%;color:#c7254e;background-color:#f9f2f4;border-radius:4px}kbd{padding:2px 4px;font-size:90%;color:#fff;background-color:#333;border-radius:3px;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,0.25);box-shadow:inset 0 -1px 0 rgba(0,0,0,0.25)}kbd kbd{padding:0;font-size:100%;font-weight:bold;-webkit-box-shadow:none;box-shadow:none}pre{display:block;padding:9.5px;margin:0 0 10px;font-size:13px;line-height:1.42857143;word-break:break-all;word-wrap:break-word;color:#333;background-color:#f5f5f5;border:1px solid #ccc;border-radius:4px}pre code{padding:0;font-size:inherit;color:inherit;white-space:pre-wrap;background-color:transparent;border-radius:0}.pre-scrollable{max-height:340px;overflow-y:scroll}.container{margin-right:auto;margin-left:auto;padding-left:15px;padding-right:15px}@media (min-width:768px){.container{width:750px}}@media (min-width:992px){.container{width:970px}}@media (min-width:1200px){.container{width:1170px}}.container-fluid{margin-right:auto;margin-left:auto;padding-left:15px;padding-right:15px}.row{margin-left:-15px;margin-right:-15px}.col-xs-1, .col-sm-1, .col-md-1, .col-lg-1, .col-xs-2, .col-sm-2, .col-md-2, .col-lg-2, .col-xs-3, .col-sm-3, .col-md-3, .col-lg-3, .col-xs-4, .col-sm-4, .col-md-4, .col-lg-4, .col-xs-5, .col-sm-5, .col-md-5, .col-lg-5, .col-xs-6, .col-sm-6, .col-md-6, .col-lg-6, .col-xs-7, .col-sm-7, .col-md-7, .col-lg-7, .col-xs-8, .col-sm-8, .col-md-8, .col-lg-8, .col-xs-9, .col-sm-9, .col-md-9, .col-lg-9, .col-xs-10, .col-sm-10, .col-md-10, .col-lg-10, .col-xs-11, .col-sm-11, .col-md-11, .col-lg-11, .col-xs-12, .col-sm-12, .col-md-12, .col-lg-12{position:relative;min-height:1px;padding-left:15px;padding-right:15px}.col-xs-1, .col-xs-2, .col-xs-3, .col-xs-4, .col-xs-5, .col-xs-6, .col-xs-7, .col-xs-8, .col-xs-9, .col-xs-10, .col-xs-11, .col-xs-12{float:left}.col-xs-12{width:100%}.col-xs-11{width:91.66666667%}.col-xs-10{width:83.33333333%}.col-xs-9{width:75%}.col-xs-8{width:66.66666667%}.col-xs-7{width:58.33333333%}.col-xs-6{width:50%}.col-xs-5{width:41.66666667%}.col-xs-4{width:33.33333333%}.col-xs-3{width:25%}.col-xs-2{width:16.66666667%}.col-xs-1{width:8.33333333%}.col-xs-pull-12{right:100%}.col-xs-pull-11{right:91.66666667%}.col-xs-pull-10{right:83.33333333%}.col-xs-pull-9{right:75%}.col-xs-pull-8{right:66.66666667%}.col-xs-pull-7{right:58.33333333%}.col-xs-pull-6{right:50%}.col-xs-pull-5{right:41.66666667%}.col-xs-pull-4{right:33.33333333%}.col-xs-pull-3{right:25%}.col-xs-pull-2{right:16.66666667%}.col-xs-pull-1{right:8.33333333%}.col-xs-pull-0{right:auto}.col-xs-push-12{left:100%}.col-xs-push-11{left:91.66666667%}.col-xs-push-10{left:83.33333333%}.col-xs-push-9{left:75%}.col-xs-push-8{left:66.66666667%}.col-xs-push-7{left:58.33333333%}.col-xs-push-6{left:50%}.col-xs-push-5{left:41.66666667%}.col-xs-push-4{left:33.33333333%}.col-xs-push-3{left:25%}.col-xs-push-2{left:16.66666667%}.col-xs-push-1{left:8.33333333%}.col-xs-push-0{left:auto}.col-xs-offset-12{margin-left:100%}.col-xs-offset-11{margin-left:91.66666667%}.col-xs-offset-10{margin-left:83.33333333%}.col-xs-offset-9{margin-left:75%}.col-xs-offset-8{margin-left:66.66666667%}.col-xs-offset-7{margin-left:58.33333333%}.col-xs-offset-6{margin-left:50%}.col-xs-offset-5{margin-left:41.66666667%}.col-xs-offset-4{margin-left:33.33333333%}.col-xs-offset-3{margin-left:25%}.col-xs-offset-2{margin-left:16.66666667%}.col-xs-offset-1{margin-left:8.33333333%}.col-xs-offset-0{margin-left:0}@media (min-width:768px){.col-sm-1, .col-sm-2, .col-sm-3, .col-sm-4, .col-sm-5, .col-sm-6, .col-sm-7, .col-sm-8, .col-sm-9, .col-sm-10, .col-sm-11, .col-sm-12{float:left}.col-sm-12{width:100%}.col-sm-11{width:91.66666667%}.col-sm-10{width:83.33333333%}.col-sm-9{width:75%}.col-sm-8{width:66.66666667%}.col-sm-7{width:58.33333333%}.col-sm-6{width:50%}.col-sm-5{width:41.66666667%}.col-sm-4{width:33.33333333%}.col-sm-3{width:25%}.col-sm-2{width:16.66666667%}.col-sm-1{width:8.33333333%}.col-sm-pull-12{right:100%}.col-sm-pull-11{right:91.66666667%}.col-sm-pull-10{right:83.33333333%}.col-sm-pull-9{right:75%}.col-sm-pull-8{right:66.66666667%}.col-sm-pull-7{right:58.33333333%}.col-sm-pull-6{right:50%}.col-sm-pull-5{right:41.66666667%}.col-sm-pull-4{right:33.33333333%}.col-sm-pull-3{right:25%}.col-sm-pull-2{right:16.66666667%}.col-sm-pull-1{right:8.33333333%}.col-sm-pull-0{right:auto}.col-sm-push-12{left:100%}.col-sm-push-11{left:91.66666667%}.col-sm-push-10{left:83.33333333%}.col-sm-push-9{left:75%}.col-sm-push-8{left:66.66666667%}.col-sm-push-7{left:58.33333333%}.col-sm-push-6{left:50%}.col-sm-push-5{left:41.66666667%}.col-sm-push-4{left:33.33333333%}.col-sm-push-3{left:25%}.col-sm-push-2{left:16.66666667%}.col-sm-push-1{left:8.33333333%}.col-sm-push-0{left:auto}.col-sm-offset-12{margin-left:100%}.col-sm-offset-11{margin-left:91.66666667%}.col-sm-offset-10{margin-left:83.33333333%}.col-sm-offset-9{margin-left:75%}.col-sm-offset-8{margin-left:66.66666667%}.col-sm-offset-7{margin-left:58.33333333%}.col-sm-offset-6{margin-left:50%}.col-sm-offset-5{margin-left:41.66666667%}.col-sm-offset-4{margin-left:33.33333333%}.col-sm-offset-3{margin-left:25%}.col-sm-offset-2{margin-left:16.66666667%}.col-sm-offset-1{margin-left:8.33333333%}.col-sm-offset-0{margin-left:0}}@media (min-width:992px){.col-md-1, .col-md-2, .col-md-3, .col-md-4, .col-md-5, .col-md-6, .col-md-7, .col-md-8, .col-md-9, .col-md-10, .col-md-11, .col-md-12{float:left}.col-md-12{width:100%}.col-md-11{width:91.66666667%}.col-md-10{width:83.33333333%}.col-md-9{width:75%}.col-md-8{width:66.66666667%}.col-md-7{width:58.33333333%}.col-md-6{width:50%}.col-md-5{width:41.66666667%}.col-md-4{width:33.33333333%}.col-md-3{width:25%}.col-md-2{width:16.66666667%}.col-md-1{width:8.33333333%}.col-md-pull-12{right:100%}.col-md-pull-11{right:91.66666667%}.col-md-pull-10{right:83.33333333%}.col-md-pull-9{right:75%}.col-md-pull-8{right:66.66666667%}.col-md-pull-7{right:58.33333333%}.col-md-pull-6{right:50%}.col-md-pull-5{right:41.66666667%}.col-md-pull-4{right:33.33333333%}.col-md-pull-3{right:25%}.col-md-pull-2{right:16.66666667%}.col-md-pull-1{right:8.33333333%}.col-md-pull-0{right:auto}.col-md-push-12{left:100%}.col-md-push-11{left:91.66666667%}.col-md-push-10{left:83.33333333%}.col-md-push-9{left:75%}.col-md-push-8{left:66.66666667%}.col-md-push-7{left:58.33333333%}.col-md-push-6{left:50%}.col-md-push-5{left:41.66666667%}.col-md-push-4{left:33.33333333%}.col-md-push-3{left:25%}.col-md-push-2{left:16.66666667%}.col-md-push-1{left:8.33333333%}.col-md-push-0{left:auto}.col-md-offset-12{margin-left:100%}.col-md-offset-11{margin-left:91.66666667%}.col-md-offset-10{margin-left:83.33333333%}.col-md-offset-9{margin-left:75%}.col-md-offset-8{margin-left:66.66666667%}.col-md-offset-7{margin-left:58.33333333%}.col-md-offset-6{margin-left:50%}.col-md-offset-5{margin-left:41.66666667%}.col-md-offset-4{margin-left:33.33333333%}.col-md-offset-3{margin-left:25%}.col-md-offset-2{margin-left:16.66666667%}.col-md-offset-1{margin-left:8.33333333%}.col-md-offset-0{margin-left:0}}@media (min-width:1200px){.col-lg-1, .col-lg-2, .col-lg-3, .col-lg-4, .col-lg-5, .col-lg-6, .col-lg-7, .col-lg-8, .col-lg-9, .col-lg-10, .col-lg-11, .col-lg-12{float:left}.col-lg-12{width:100%}.col-lg-11{width:91.66666667%}.col-lg-10{width:83.33333333%}.col-lg-9{width:75%}.col-lg-8{width:66.66666667%}.col-lg-7{width:58.33333333%}.col-lg-6{width:50%}.col-lg-5{width:41.66666667%}.col-lg-4{width:33.33333333%}.col-lg-3{width:25%}.col-lg-2{width:16.66666667%}.col-lg-1{width:8.33333333%}.col-lg-pull-12{right:100%}.col-lg-pull-11{right:91.66666667%}.col-lg-pull-10{right:83.33333333%}.col-lg-pull-9{right:75%}.col-lg-pull-8{right:66.66666667%}.col-lg-pull-7{right:58.33333333%}.col-lg-pull-6{right:50%}.col-lg-pull-5{right:41.66666667%}.col-lg-pull-4{right:33.33333333%}.col-lg-pull-3{right:25%}.col-lg-pull-2{right:16.66666667%}.col-lg-pull-1{right:8.33333333%}.col-lg-pull-0{right:auto}.col-lg-push-12{left:100%}.col-lg-push-11{left:91.66666667%}.col-lg-push-10{left:83.33333333%}.col-lg-push-9{left:75%}.col-lg-push-8{left:66.66666667%}.col-lg-push-7{left:58.33333333%}.col-lg-push-6{left:50%}.col-lg-push-5{left:41.66666667%}.col-lg-push-4{left:33.33333333%}.col-lg-push-3{left:25%}.col-lg-push-2{left:16.66666667%}.col-lg-push-1{left:8.33333333%}.col-lg-push-0{left:auto}.col-lg-offset-12{margin-left:100%}.col-lg-offset-11{margin-left:91.66666667%}.col-lg-offset-10{margin-left:83.33333333%}.col-lg-offset-9{margin-left:75%}.col-lg-offset-8{margin-left:66.66666667%}.col-lg-offset-7{margin-left:58.33333333%}.col-lg-offset-6{margin-left:50%}.col-lg-offset-5{margin-left:41.66666667%}.col-lg-offset-4{margin-left:33.33333333%}.col-lg-offset-3{margin-left:25%}.col-lg-offset-2{margin-left:16.66666667%}.col-lg-offset-1{margin-left:8.33333333%}.col-lg-offset-0{margin-left:0}}table{background-color:transparent}caption{padding-top:8px;padding-bottom:8px;color:#777;text-align:left}th{text-align:left}.table{width:100%;max-width:100%;margin-bottom:20px}.table>thead>tr>th,.table>tbody>tr>th,.table>tfoot>tr>th,.table>thead>tr>td,.table>tbody>tr>td,.table>tfoot>tr>td{padding:8px;line-height:1.42857143;vertical-align:top;border-top:1px solid #ddd}.table>thead>tr>th{vertical-align:bottom;border-bottom:2px solid #ddd}.table>caption+thead>tr:first-child>th,.table>colgroup+thead>tr:first-child>th,.table>thead:first-child>tr:first-child>th,.table>caption+thead>tr:first-child>td,.table>colgroup+thead>tr:first-child>td,.table>thead:first-child>tr:first-child>td{border-top:0}.table>tbody+tbody{border-top:2px solid #ddd}.table .table{background-color:#fff}.table-condensed>thead>tr>th,.table-condensed>tbody>tr>th,.table-condensed>tfoot>tr>th,.table-condensed>thead>tr>td,.table-condensed>tbody>tr>td,.table-condensed>tfoot>tr>td{padding:5px}.table-bordered{border:1px solid #ddd}.table-bordered>thead>tr>th,.table-bordered>tbody>tr>th,.table-bordered>tfoot>tr>th,.table-bordered>thead>tr>td,.table-bordered>tbody>tr>td,.table-bordered>tfoot>tr>td{border:1px solid #ddd}.table-bordered>thead>tr>th,.table-bordered>thead>tr>td{border-bottom-width:2px}.table-striped>tbody>tr:nth-child(odd){background-color:#f9f9f9}.table-hover>tbody>tr:hover{background-color:#f5f5f5}table col[class*="col-"]{position:static;float:none;display:table-column}table td[class*="col-"],table th[class*="col-"]{position:static;float:none;display:table-cell}.table>thead>tr>td.active,.table>tbody>tr>td.active,.table>tfoot>tr>td.active,.table>thead>tr>th.active,.table>tbody>tr>th.active,.table>tfoot>tr>th.active,.table>thead>tr.active>td,.table>tbody>tr.active>td,.table>tfoot>tr.active>td,.table>thead>tr.active>th,.table>tbody>tr.active>th,.table>tfoot>tr.active>th{background-color:#f5f5f5}.table-hover>tbody>tr>td.active:hover,.table-hover>tbody>tr>th.active:hover,.table-hover>tbody>tr.active:hover>td,.table-hover>tbody>tr:hover>.active,.table-hover>tbody>tr.active:hover>th{background-color:#e8e8e8}.table>thead>tr>td.success,.table>tbody>tr>td.success,.table>tfoot>tr>td.success,.table>thead>tr>th.success,.table>tbody>tr>th.success,.table>tfoot>tr>th.success,.table>thead>tr.success>td,.table>tbody>tr.success>td,.table>tfoot>tr.success>td,.table>thead>tr.success>th,.table>tbody>tr.success>th,.table>tfoot>tr.success>th{background-color:#dff0d8}.table-hover>tbody>tr>td.success:hover,.table-hover>tbody>tr>th.success:hover,.table-hover>tbody>tr.success:hover>td,.table-hover>tbody>tr:hover>.success,.table-hover>tbody>tr.success:hover>th{background-color:#d0e9c6}.table>thead>tr>td.info,.table>tbody>tr>td.info,.table>tfoot>tr>td.info,.table>thead>tr>th.info,.table>tbody>tr>th.info,.table>tfoot>tr>th.info,.table>thead>tr.info>td,.table>tbody>tr.info>td,.table>tfoot>tr.info>td,.table>thead>tr.info>th,.table>tbody>tr.info>th,.table>tfoot>tr.info>th{background-color:#d9edf7}.table-hover>tbody>tr>td.info:hover,.table-hover>tbody>tr>th.info:hover,.table-hover>tbody>tr.info:hover>td,.table-hover>tbody>tr:hover>.info,.table-hover>tbody>tr.info:hover>th{background-color:#c4e3f3}.table>thead>tr>td.warning,.table>tbody>tr>td.warning,.table>tfoot>tr>td.warning,.table>thead>tr>th.warning,.table>tbody>tr>th.warning,.table>tfoot>tr>th.warning,.table>thead>tr.warning>td,.table>tbody>tr.warning>td,.table>tfoot>tr.warning>td,.table>thead>tr.warning>th,.table>tbody>tr.warning>th,.table>tfoot>tr.warning>th{background-color:#fcf8e3}.table-hover>tbody>tr>td.warning:hover,.table-hover>tbody>tr>th.warning:hover,.table-hover>tbody>tr.warning:hover>td,.table-hover>tbody>tr:hover>.warning,.table-hover>tbody>tr.warning:hover>th{background-color:#faf2cc}.table>thead>tr>td.danger,.table>tbody>tr>td.danger,.table>tfoot>tr>td.danger,.table>thead>tr>th.danger,.table>tbody>tr>th.danger,.table>tfoot>tr>th.danger,.table>thead>tr.danger>td,.table>tbody>tr.danger>td,.table>tfoot>tr.danger>td,.table>thead>tr.danger>th,.table>tbody>tr.danger>th,.table>tfoot>tr.danger>th{background-color:#f2dede}.table-hover>tbody>tr>td.danger:hover,.table-hover>tbody>tr>th.danger:hover,.table-hover>tbody>tr.danger:hover>td,.table-hover>tbody>tr:hover>.danger,.table-hover>tbody>tr.danger:hover>th{background-color:#ebcccc}.table-responsive{overflow-x:auto;min-height:0.01%}@media screen and (max-width:767px){.table-responsive{width:100%;margin-bottom:15px;overflow-y:hidden;-ms-overflow-style:-ms-autohiding-scrollbar;border:1px solid #ddd}.table-responsive>.table{margin-bottom:0}.table-responsive>.table>thead>tr>th,.table-responsive>.table>tbody>tr>th,.table-responsive>.table>tfoot>tr>th,.table-responsive>.table>thead>tr>td,.table-responsive>.table>tbody>tr>td,.table-responsive>.table>tfoot>tr>td{white-space:nowrap}.table-responsive>.table-bordered{border:0}.table-responsive>.table-bordered>thead>tr>th:first-child,.table-responsive>.table-bordered>tbody>tr>th:first-child,.table-responsive>.table-bordered>tfoot>tr>th:first-child,.table-responsive>.table-bordered>thead>tr>td:first-child,.table-responsive>.table-bordered>tbody>tr>td:first-child,.table-responsive>.table-bordered>tfoot>tr>td:first-child{border-left:0}.table-responsive>.table-bordered>thead>tr>th:last-child,.table-responsive>.table-bordered>tbody>tr>th:last-child,.table-responsive>.table-bordered>tfoot>tr>th:last-child,.table-responsive>.table-bordered>thead>tr>td:last-child,.table-responsive>.table-bordered>tbody>tr>td:last-child,.table-responsive>.table-bordered>tfoot>tr>td:last-child{border-right:0}.table-responsive>.table-bordered>tbody>tr:last-child>th,.table-responsive>.table-bordered>tfoot>tr:last-child>th,.table-responsive>.table-bordered>tbody>tr:last-child>td,.table-responsive>.table-bordered>tfoot>tr:last-child>td{border-bottom:0}}fieldset{padding:0;margin:0;border:0;min-width:0}legend{display:block;width:100%;padding:0;margin-bottom:20px;font-size:21px;line-height:inherit;color:#333;border:0;border-bottom:1px solid #e5e5e5}label{display:inline-block;max-width:100%;margin-bottom:5px;font-weight:bold}input[type="search"]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type="radio"],input[type="checkbox"]{margin:4px 0 0;margin-top:1px \9;line-height:normal}input[type="file"]{display:block}input[type="range"]{display:block;width:100%}select[multiple],select[size]{height:auto}input[type="file"]:focus,input[type="radio"]:focus,input[type="checkbox"]:focus{outline:thin dotted;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}output{display:block;padding-top:7px;font-size:14px;line-height:1.42857143;color:#555}.form-control{display:block;width:100%;height:34px;padding:6px 12px;font-size:14px;line-height:1.42857143;color:#555;background-color:#fff;background-image:none;border:1px solid #ccc;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);-webkit-transition:border-color ease-in-out .15s, -webkit-box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s, box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s, box-shadow ease-in-out .15s}.form-control:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6);box-shadow:inset 0 1px 1px rgba(0,0,0,.075), 0 0 8px rgba(102, 175, 233, 0.6)}.form-control::-moz-placeholder{color:#777;opacity:1}.form-control:-ms-input-placeholder{color:#777}.form-control::-webkit-input-placeholder{color:#777}.form-control[disabled],.form-control[readonly],fieldset[disabled] .form-control{cursor:not-allowed;background-color:#eee;opacity:1}textarea.form-control{height:auto}input[type="search"]{-webkit-appearance:none}@media screen and (-webkit-min-device-pixel-ratio:0){input[type="date"],input[type="time"],input[type="datetime-local"],input[type="month"]{line-height:34px}input[type="date"].input-sm,input[type="time"].input-sm,input[type="datetime-local"].input-sm,input[type="month"].input-sm{line-height:30px}input[type="date"].input-lg,input[type="time"].input-lg,input[type="datetime-local"].input-lg,input[type="month"].input-lg{line-height:46px}}.form-group{margin-bottom:15px}.radio,.checkbox{position:relative;display:block;margin-top:10px;margin-bottom:10px}.radio label,.checkbox label{min-height:20px;padding-left:20px;margin-bottom:0;font-weight:normal;cursor:pointer}.radio input[type="radio"],.radio-inline input[type="radio"],.checkbox input[type="checkbox"],.checkbox-inline input[type="checkbox"]{position:absolute;margin-left:-20px;margin-top:4px \9}.radio+.radio,.checkbox+.checkbox{margin-top:-5px}.radio-inline,.checkbox-inline{display:inline-block;padding-left:20px;margin-bottom:0;vertical-align:middle;font-weight:normal;cursor:pointer}.radio-inline+.radio-inline,.checkbox-inline+.checkbox-inline{margin-top:0;margin-left:10px}input[type="radio"][disabled],input[type="checkbox"][disabled],input[type="radio"].disabled,input[type="checkbox"].disabled,fieldset[disabled] input[type="radio"],fieldset[disabled] input[type="checkbox"]{cursor:not-allowed}.radio-inline.disabled,.checkbox-inline.disabled,fieldset[disabled] .radio-inline,fieldset[disabled] .checkbox-inline{cursor:not-allowed}.radio.disabled label,.checkbox.disabled label,fieldset[disabled] .radio label,fieldset[disabled] .checkbox label{cursor:not-allowed}.form-control-static{padding-top:7px;padding-bottom:7px;margin-bottom:0}.form-control-static.input-lg,.form-control-static.input-sm{padding-left:0;padding-right:0}.input-sm,.form-group-sm .form-control{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-sm,select.form-group-sm .form-control{height:30px;line-height:30px}textarea.input-sm,textarea.form-group-sm .form-control,select[multiple].input-sm,select[multiple].form-group-sm .form-control{height:auto}.input-lg,.form-group-lg .form-control{height:46px;padding:10px 16px;font-size:18px;line-height:1.33;border-radius:6px}select.input-lg,select.form-group-lg .form-control{height:46px;line-height:46px}textarea.input-lg,textarea.form-group-lg .form-control,select[multiple].input-lg,select[multiple].form-group-lg .form-control{height:auto}.has-feedback{position:relative}.has-feedback .form-control{padding-right:42.5px}.form-control-feedback{position:absolute;top:0;right:0;z-index:2;display:block;width:34px;height:34px;line-height:34px;text-align:center;pointer-events:none}.input-lg+.form-control-feedback{width:46px;height:46px;line-height:46px}.input-sm+.form-control-feedback{width:30px;height:30px;line-height:30px}.has-success .help-block,.has-success .control-label,.has-success .radio,.has-success .checkbox,.has-success .radio-inline,.has-success .checkbox-inline,.has-success.radio label,.has-success.checkbox label,.has-success.radio-inline label,.has-success.checkbox-inline label{color:#3c763d}.has-success .form-control{border-color:#3c763d;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.has-success .form-control:focus{border-color:#2b542c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #67b168;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #67b168}.has-success .input-group-addon{color:#3c763d;border-color:#3c763d;background-color:#dff0d8}.has-success .form-control-feedback{color:#3c763d}.has-warning .help-block,.has-warning .control-label,.has-warning .radio,.has-warning .checkbox,.has-warning .radio-inline,.has-warning .checkbox-inline,.has-warning.radio label,.has-warning.checkbox label,.has-warning.radio-inline label,.has-warning.checkbox-inline label{color:#8a6d3b}.has-warning .form-control{border-color:#8a6d3b;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.has-warning .form-control:focus{border-color:#66512c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #c0a16b;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #c0a16b}.has-warning .input-group-addon{color:#8a6d3b;border-color:#8a6d3b;background-color:#fcf8e3}.has-warning .form-control-feedback{color:#8a6d3b}.has-error .help-block,.has-error .control-label,.has-error .radio,.has-error .checkbox,.has-error .radio-inline,.has-error .checkbox-inline,.has-error.radio label,.has-error.checkbox label,.has-error.radio-inline label,.has-error.checkbox-inline label{color:#a94442}.has-error .form-control{border-color:#a94442;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075);box-shadow:inset 0 1px 1px rgba(0,0,0,0.075)}.has-error .form-control:focus{border-color:#843534;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #ce8483;box-shadow:inset 0 1px 1px rgba(0,0,0,0.075),0 0 6px #ce8483}.has-error .input-group-addon{color:#a94442;border-color:#a94442;background-color:#f2dede}.has-error .form-control-feedback{color:#a94442}.has-feedback label~.form-control-feedback{top:25px}.has-feedback label.sr-only~.form-control-feedback{top:0}.help-block{display:block;margin-top:5px;margin-bottom:10px;color:#737373}@media (min-width:768px){.form-inline .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.form-inline .form-control{display:inline-block;width:auto;vertical-align:middle}.form-inline .form-control-static{display:inline-block}.form-inline .input-group{display:inline-table;vertical-align:middle}.form-inline .input-group .input-group-addon,.form-inline .input-group .input-group-btn,.form-inline .input-group .form-control{width:auto}.form-inline .input-group>.form-control{width:100%}.form-inline .control-label{margin-bottom:0;vertical-align:middle}.form-inline .radio,.form-inline .checkbox{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.form-inline .radio label,.form-inline .checkbox label{padding-left:0}.form-inline .radio input[type="radio"],.form-inline .checkbox input[type="checkbox"]{position:relative;margin-left:0}.form-inline .has-feedback .form-control-feedback{top:0}}.form-horizontal .radio,.form-horizontal .checkbox,.form-horizontal .radio-inline,.form-horizontal .checkbox-inline{margin-top:0;margin-bottom:0;padding-top:7px}.form-horizontal .radio,.form-horizontal .checkbox{min-height:27px}.form-horizontal .form-group{margin-left:-15px;margin-right:-15px}@media (min-width:768px){.form-horizontal .control-label{text-align:right;margin-bottom:0;padding-top:7px}}.form-horizontal .has-feedback .form-control-feedback{right:15px}@media (min-width:768px){.form-horizontal .form-group-lg .control-label{padding-top:14.3px}}@media (min-width:768px){.form-horizontal .form-group-sm .control-label{padding-top:6px}}.btn{display:inline-block;margin-bottom:0;font-weight:normal;text-align:center;vertical-align:middle;-ms-touch-action:manipulation;touch-action:manipulation;cursor:pointer;background-image:none;border:1px solid transparent;white-space:nowrap;padding:6px 12px;font-size:14px;line-height:1.42857143;border-radius:4px;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.btn:focus,.btn:active:focus,.btn.active:focus,.btn.focus,.btn:active.focus,.btn.active.focus{outline:thin dotted;outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.btn:hover,.btn:focus,.btn.focus{color:#333;text-decoration:none}.btn:active,.btn.active{outline:0;background-image:none;-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,0.125);box-shadow:inset 0 3px 5px rgba(0,0,0,0.125)}.btn.disabled,.btn[disabled],fieldset[disabled] .btn{cursor:not-allowed;pointer-events:none;opacity:.65;filter:alpha(opacity=65);-webkit-box-shadow:none;box-shadow:none}.btn-default{color:#333;background-color:#fff;border-color:#ccc}.btn-default:hover,.btn-default:focus,.btn-default.focus,.btn-default:active,.btn-default.active,.open>.dropdown-toggle.btn-default{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default:active,.btn-default.active,.open>.dropdown-toggle.btn-default{background-image:none}.btn-default.disabled,.btn-default[disabled],fieldset[disabled] .btn-default,.btn-default.disabled:hover,.btn-default[disabled]:hover,fieldset[disabled] .btn-default:hover,.btn-default.disabled:focus,.btn-default[disabled]:focus,fieldset[disabled] .btn-default:focus,.btn-default.disabled.focus,.btn-default[disabled].focus,fieldset[disabled] .btn-default.focus,.btn-default.disabled:active,.btn-default[disabled]:active,fieldset[disabled] .btn-default:active,.btn-default.disabled.active,.btn-default[disabled].active,fieldset[disabled] .btn-default.active{background-color:#fff;border-color:#ccc}.btn-default .badge{color:#fff;background-color:#333}.btn-primary{color:#fff;background-color:#428bca;border-color:#357ebd}.btn-primary:hover,.btn-primary:focus,.btn-primary.focus,.btn-primary:active,.btn-primary.active,.open>.dropdown-toggle.btn-primary{color:#fff;background-color:#3071a9;border-color:#285e8e}.btn-primary:active,.btn-primary.active,.open>.dropdown-toggle.btn-primary{background-image:none}.btn-primary.disabled,.btn-primary[disabled],fieldset[disabled] .btn-primary,.btn-primary.disabled:hover,.btn-primary[disabled]:hover,fieldset[disabled] .btn-primary:hover,.btn-primary.disabled:focus,.btn-primary[disabled]:focus,fieldset[disabled] .btn-primary:focus,.btn-primary.disabled.focus,.btn-primary[disabled].focus,fieldset[disabled] .btn-primary.focus,.btn-primary.disabled:active,.btn-primary[disabled]:active,fieldset[disabled] .btn-primary:active,.btn-primary.disabled.active,.btn-primary[disabled].active,fieldset[disabled] .btn-primary.active{background-color:#428bca;border-color:#357ebd}.btn-primary .badge{color:#428bca;background-color:#fff}.btn-success{color:#fff;background-color:#5cb85c;border-color:#4cae4c}.btn-success:hover,.btn-success:focus,.btn-success.focus,.btn-success:active,.btn-success.active,.open>.dropdown-toggle.btn-success{color:#fff;background-color:#449d44;border-color:#398439}.btn-success:active,.btn-success.active,.open>.dropdown-toggle.btn-success{background-image:none}.btn-success.disabled,.btn-success[disabled],fieldset[disabled] .btn-success,.btn-success.disabled:hover,.btn-success[disabled]:hover,fieldset[disabled] .btn-success:hover,.btn-success.disabled:focus,.btn-success[disabled]:focus,fieldset[disabled] .btn-success:focus,.btn-success.disabled.focus,.btn-success[disabled].focus,fieldset[disabled] .btn-success.focus,.btn-success.disabled:active,.btn-success[disabled]:active,fieldset[disabled] .btn-success:active,.btn-success.disabled.active,.btn-success[disabled].active,fieldset[disabled] .btn-success.active{background-color:#5cb85c;border-color:#4cae4c}.btn-success .badge{color:#5cb85c;background-color:#fff}.btn-info{color:#fff;background-color:#5bc0de;border-color:#46b8da}.btn-info:hover,.btn-info:focus,.btn-info.focus,.btn-info:active,.btn-info.active,.open>.dropdown-toggle.btn-info{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info:active,.btn-info.active,.open>.dropdown-toggle.btn-info{background-image:none}.btn-info.disabled,.btn-info[disabled],fieldset[disabled] .btn-info,.btn-info.disabled:hover,.btn-info[disabled]:hover,fieldset[disabled] .btn-info:hover,.btn-info.disabled:focus,.btn-info[disabled]:focus,fieldset[disabled] .btn-info:focus,.btn-info.disabled.focus,.btn-info[disabled].focus,fieldset[disabled] .btn-info.focus,.btn-info.disabled:active,.btn-info[disabled]:active,fieldset[disabled] .btn-info:active,.btn-info.disabled.active,.btn-info[disabled].active,fieldset[disabled] .btn-info.active{background-color:#5bc0de;border-color:#46b8da}.btn-info .badge{color:#5bc0de;background-color:#fff}.btn-warning{color:#fff;background-color:#f0ad4e;border-color:#eea236}.btn-warning:hover,.btn-warning:focus,.btn-warning.focus,.btn-warning:active,.btn-warning.active,.open>.dropdown-toggle.btn-warning{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning:active,.btn-warning.active,.open>.dropdown-toggle.btn-warning{background-image:none}.btn-warning.disabled,.btn-warning[disabled],fieldset[disabled] .btn-warning,.btn-warning.disabled:hover,.btn-warning[disabled]:hover,fieldset[disabled] .btn-warning:hover,.btn-warning.disabled:focus,.btn-warning[disabled]:focus,fieldset[disabled] .btn-warning:focus,.btn-warning.disabled.focus,.btn-warning[disabled].focus,fieldset[disabled] .btn-warning.focus,.btn-warning.disabled:active,.btn-warning[disabled]:active,fieldset[disabled] .btn-warning:active,.btn-warning.disabled.active,.btn-warning[disabled].active,fieldset[disabled] .btn-warning.active{background-color:#f0ad4e;border-color:#eea236}.btn-warning .badge{color:#f0ad4e;background-color:#fff}.btn-danger{color:#fff;background-color:#d9534f;border-color:#d43f3a}.btn-danger:hover,.btn-danger:focus,.btn-danger.focus,.btn-danger:active,.btn-danger.active,.open>.dropdown-toggle.btn-danger{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger:active,.btn-danger.active,.open>.dropdown-toggle.btn-danger{background-image:none}.btn-danger.disabled,.btn-danger[disabled],fieldset[disabled] .btn-danger,.btn-danger.disabled:hover,.btn-danger[disabled]:hover,fieldset[disabled] .btn-danger:hover,.btn-danger.disabled:focus,.btn-danger[disabled]:focus,fieldset[disabled] .btn-danger:focus,.btn-danger.disabled.focus,.btn-danger[disabled].focus,fieldset[disabled] .btn-danger.focus,.btn-danger.disabled:active,.btn-danger[disabled]:active,fieldset[disabled] .btn-danger:active,.btn-danger.disabled.active,.btn-danger[disabled].active,fieldset[disabled] .btn-danger.active{background-color:#d9534f;border-color:#d43f3a}.btn-danger .badge{color:#d9534f;background-color:#fff}.btn-link{color:#428bca;font-weight:normal;border-radius:0}.btn-link,.btn-link:active,.btn-link.active,.btn-link[disabled],fieldset[disabled] .btn-link{background-color:transparent;-webkit-box-shadow:none;box-shadow:none}.btn-link,.btn-link:hover,.btn-link:focus,.btn-link:active{border-color:transparent}.btn-link:hover,.btn-link:focus{color:#2a6496;text-decoration:underline;background-color:transparent}.btn-link[disabled]:hover,fieldset[disabled] .btn-link:hover,.btn-link[disabled]:focus,fieldset[disabled] .btn-link:focus{color:#777;text-decoration:none}.btn-lg,.btn-group-lg>.btn{padding:10px 16px;font-size:18px;line-height:1.33;border-radius:6px}.btn-sm,.btn-group-sm>.btn{padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.btn-xs,.btn-group-xs>.btn{padding:1px 5px;font-size:12px;line-height:1.5;border-radius:3px}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:5px}input[type="submit"].btn-block,input[type="reset"].btn-block,input[type="button"].btn-block{width:100%}.fade{opacity:0;-webkit-transition:opacity .15s linear;-o-transition:opacity .15s linear;transition:opacity .15s linear}.fade.in{opacity:1}.collapse{display:none;visibility:hidden}.collapse.in{display:block;visibility:visible}tr.collapse.in{display:table-row}tbody.collapse.in{display:table-row-group}.collapsing{position:relative;height:0;overflow:hidden;-webkit-transition-property:height, visibility;-o-transition-property:height, visibility;transition-property:height, visibility;-webkit-transition-duration:.35s;-o-transition-duration:.35s;transition-duration:.35s;-webkit-transition-timing-function:ease;-o-transition-timing-function:ease;transition-timing-function:ease}.caret{display:inline-block;width:0;height:0;margin-left:2px;vertical-align:middle;border-top:4px solid;border-right:4px solid transparent;border-left:4px solid transparent}.dropdown{position:relative}.dropdown-toggle:focus{outline:0}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:160px;padding:5px 0;margin:2px 0 0;list-style:none;font-size:14px;text-align:left;background-color:#fff;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.15);border-radius:4px;-webkit-box-shadow:0 6px 12px rgba(0,0,0,0.175);box-shadow:0 6px 12px rgba(0,0,0,0.175);-webkit-background-clip:padding-box;background-clip:padding-box}.dropdown-menu.pull-right{right:0;left:auto}.dropdown-menu .divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.dropdown-menu>li>a{display:block;padding:3px 20px;clear:both;font-weight:normal;line-height:1.42857143;color:#333;white-space:nowrap}.dropdown-menu>li>a:hover,.dropdown-menu>li>a:focus{text-decoration:none;color:#262626;background-color:#f5f5f5}.dropdown-menu>.active>a,.dropdown-menu>.active>a:hover,.dropdown-menu>.active>a:focus{color:#fff;text-decoration:none;outline:0;background-color:#428bca}.dropdown-menu>.disabled>a,.dropdown-menu>.disabled>a:hover,.dropdown-menu>.disabled>a:focus{color:#777}.dropdown-menu>.disabled>a:hover,.dropdown-menu>.disabled>a:focus{text-decoration:none;background-color:transparent;background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);cursor:not-allowed}.open>.dropdown-menu{display:block}.open>a{outline:0}.dropdown-menu-right{left:auto;right:0}.dropdown-menu-left{left:0;right:auto}.dropdown-header{display:block;padding:3px 20px;font-size:12px;line-height:1.42857143;color:#777;white-space:nowrap}.dropdown-backdrop{position:fixed;left:0;right:0;bottom:0;top:0;z-index:990}.pull-right>.dropdown-menu{right:0;left:auto}.dropup .caret,.navbar-fixed-bottom .dropdown .caret{border-top:0;border-bottom:4px solid;content:""}.dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:1px}@media (min-width:768px){.navbar-right .dropdown-menu{left:auto;right:0}.navbar-right .dropdown-menu-left{left:0;right:auto}}.btn-group,.btn-group-vertical{position:relative;display:inline-block;vertical-align:middle}.btn-group>.btn,.btn-group-vertical>.btn{position:relative;float:left}.btn-group>.btn:hover,.btn-group-vertical>.btn:hover,.btn-group>.btn:focus,.btn-group-vertical>.btn:focus,.btn-group>.btn:active,.btn-group-vertical>.btn:active,.btn-group>.btn.active,.btn-group-vertical>.btn.active{z-index:2}.btn-group .btn+.btn,.btn-group .btn+.btn-group,.btn-group .btn-group+.btn,.btn-group .btn-group+.btn-group{margin-left:-1px}.btn-toolbar{margin-left:-5px}.btn-toolbar .btn-group,.btn-toolbar .input-group{float:left}.btn-toolbar>.btn,.btn-toolbar>.btn-group,.btn-toolbar>.input-group{margin-left:5px}.btn-group>.btn:not(:first-child):not(:last-child):not(.dropdown-toggle){border-radius:0}.btn-group>.btn:first-child{margin-left:0}.btn-group>.btn:first-child:not(:last-child):not(.dropdown-toggle){border-bottom-right-radius:0;border-top-right-radius:0}.btn-group>.btn:last-child:not(:first-child),.btn-group>.dropdown-toggle:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.btn-group>.btn-group{float:left}.btn-group>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group>.btn-group:first-child>.btn:last-child,.btn-group>.btn-group:first-child>.dropdown-toggle{border-bottom-right-radius:0;border-top-right-radius:0}.btn-group>.btn-group:last-child>.btn:first-child{border-bottom-left-radius:0;border-top-left-radius:0}.btn-group .dropdown-toggle:active,.btn-group.open .dropdown-toggle{outline:0}.btn-group>.btn+.dropdown-toggle{padding-left:8px;padding-right:8px}.btn-group>.btn-lg+.dropdown-toggle{padding-left:12px;padding-right:12px}.btn-group.open .dropdown-toggle{-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,0.125);box-shadow:inset 0 3px 5px rgba(0,0,0,0.125)}.btn-group.open .dropdown-toggle.btn-link{-webkit-box-shadow:none;box-shadow:none}.btn .caret{margin-left:0}.btn-lg .caret{border-width:5px 5px 0;border-bottom-width:0}.dropup .btn-lg .caret{border-width:0 5px 5px}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group,.btn-group-vertical>.btn-group>.btn{display:block;float:none;width:100%;max-width:100%}.btn-group-vertical>.btn-group>.btn{float:none}.btn-group-vertical>.btn+.btn,.btn-group-vertical>.btn+.btn-group,.btn-group-vertical>.btn-group+.btn,.btn-group-vertical>.btn-group+.btn-group{margin-top:-1px;margin-left:0}.btn-group-vertical>.btn:not(:first-child):not(:last-child){border-radius:0}.btn-group-vertical>.btn:first-child:not(:last-child){border-top-right-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn:last-child:not(:first-child){border-bottom-left-radius:4px;border-top-right-radius:0;border-top-left-radius:0}.btn-group-vertical>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group-vertical>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group-vertical>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-right-radius:0;border-top-left-radius:0}.btn-group-justified{display:table;width:100%;table-layout:fixed;border-collapse:separate}.btn-group-justified>.btn,.btn-group-justified>.btn-group{float:none;display:table-cell;width:1%}.btn-group-justified>.btn-group .btn{width:100%}.btn-group-justified>.btn-group .dropdown-menu{left:auto}[data-toggle="buttons"]>.btn input[type="radio"],[data-toggle="buttons"]>.btn-group>.btn input[type="radio"],[data-toggle="buttons"]>.btn input[type="checkbox"],[data-toggle="buttons"]>.btn-group>.btn input[type="checkbox"]{position:absolute;clip:rect(0, 0, 0, 0);pointer-events:none}.input-group{position:relative;display:table;border-collapse:separate}.input-group[class*="col-"]{float:none;padding-left:0;padding-right:0}.input-group .form-control{position:relative;z-index:2;float:left;width:100%;margin-bottom:0}.input-group-lg>.form-control,.input-group-lg>.input-group-addon,.input-group-lg>.input-group-btn>.btn{height:46px;padding:10px 16px;font-size:18px;line-height:1.33;border-radius:6px}select.input-group-lg>.form-control,select.input-group-lg>.input-group-addon,select.input-group-lg>.input-group-btn>.btn{height:46px;line-height:46px}textarea.input-group-lg>.form-control,textarea.input-group-lg>.input-group-addon,textarea.input-group-lg>.input-group-btn>.btn,select[multiple].input-group-lg>.form-control,select[multiple].input-group-lg>.input-group-addon,select[multiple].input-group-lg>.input-group-btn>.btn{height:auto}.input-group-sm>.form-control,.input-group-sm>.input-group-addon,.input-group-sm>.input-group-btn>.btn{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-group-sm>.form-control,select.input-group-sm>.input-group-addon,select.input-group-sm>.input-group-btn>.btn{height:30px;line-height:30px}textarea.input-group-sm>.form-control,textarea.input-group-sm>.input-group-addon,textarea.input-group-sm>.input-group-btn>.btn,select[multiple].input-group-sm>.form-control,select[multiple].input-group-sm>.input-group-addon,select[multiple].input-group-sm>.input-group-btn>.btn{height:auto}.input-group-addon,.input-group-btn,.input-group .form-control{display:table-cell}.input-group-addon:not(:first-child):not(:last-child),.input-group-btn:not(:first-child):not(:last-child),.input-group .form-control:not(:first-child):not(:last-child){border-radius:0}.input-group-addon,.input-group-btn{width:1%;white-space:nowrap;vertical-align:middle}.input-group-addon{padding:6px 12px;font-size:14px;font-weight:normal;line-height:1;color:#555;text-align:center;background-color:#eee;border:1px solid #ccc;border-radius:4px}.input-group-addon.input-sm{padding:5px 10px;font-size:12px;border-radius:3px}.input-group-addon.input-lg{padding:10px 16px;font-size:18px;border-radius:6px}.input-group-addon input[type="radio"],.input-group-addon input[type="checkbox"]{margin-top:0}.input-group .form-control:first-child,.input-group-addon:first-child,.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group>.btn,.input-group-btn:first-child>.dropdown-toggle,.input-group-btn:last-child>.btn:not(:last-child):not(.dropdown-toggle),.input-group-btn:last-child>.btn-group:not(:last-child)>.btn{border-bottom-right-radius:0;border-top-right-radius:0}.input-group-addon:first-child{border-right:0}.input-group .form-control:last-child,.input-group-addon:last-child,.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group>.btn,.input-group-btn:last-child>.dropdown-toggle,.input-group-btn:first-child>.btn:not(:first-child),.input-group-btn:first-child>.btn-group:not(:first-child)>.btn{border-bottom-left-radius:0;border-top-left-radius:0}.input-group-addon:last-child{border-left:0}.input-group-btn{position:relative;font-size:0;white-space:nowrap}.input-group-btn>.btn{position:relative}.input-group-btn>.btn+.btn{margin-left:-1px}.input-group-btn>.btn:hover,.input-group-btn>.btn:focus,.input-group-btn>.btn:active{z-index:2}.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group{margin-right:-1px}.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group{margin-left:-1px}.nav{margin-bottom:0;padding-left:0;list-style:none}.nav>li{position:relative;display:block}.nav>li>a{position:relative;display:block;padding:10px 15px}.nav>li>a:hover,.nav>li>a:focus{text-decoration:none;background-color:#eee}.nav>li.disabled>a{color:#777}.nav>li.disabled>a:hover,.nav>li.disabled>a:focus{color:#777;text-decoration:none;background-color:transparent;cursor:not-allowed}.nav .open>a,.nav .open>a:hover,.nav .open>a:focus{background-color:#eee;border-color:#428bca}.nav .nav-divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.nav>li>a>img{max-width:none}.nav-tabs{border-bottom:1px solid #ddd}.nav-tabs>li{float:left;margin-bottom:-1px}.nav-tabs>li>a{margin-right:2px;line-height:1.42857143;border:1px solid transparent;border-radius:4px 4px 0 0}.nav-tabs>li>a:hover{border-color:#eee #eee #ddd}.nav-tabs>li.active>a,.nav-tabs>li.active>a:hover,.nav-tabs>li.active>a:focus{color:#555;background-color:#fff;border:1px solid #ddd;border-bottom-color:transparent;cursor:default}.nav-tabs.nav-justified{width:100%;border-bottom:0}.nav-tabs.nav-justified>li{float:none}.nav-tabs.nav-justified>li>a{text-align:center;margin-bottom:5px}.nav-tabs.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-tabs.nav-justified>li{display:table-cell;width:1%}.nav-tabs.nav-justified>li>a{margin-bottom:0}}.nav-tabs.nav-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:hover,.nav-tabs.nav-justified>.active>a:focus{border:1px solid #ddd}@media (min-width:768px){.nav-tabs.nav-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:hover,.nav-tabs.nav-justified>.active>a:focus{border-bottom-color:#fff}}.nav-pills>li{float:left}.nav-pills>li>a{border-radius:4px}.nav-pills>li+li{margin-left:2px}.nav-pills>li.active>a,.nav-pills>li.active>a:hover,.nav-pills>li.active>a:focus{color:#fff;background-color:#428bca}.nav-stacked>li{float:none}.nav-stacked>li+li{margin-top:2px;margin-left:0}.nav-justified{width:100%}.nav-justified>li{float:none}.nav-justified>li>a{text-align:center;margin-bottom:5px}.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width:768px){.nav-justified>li{display:table-cell;width:1%}.nav-justified>li>a{margin-bottom:0}}.nav-tabs-justified{border-bottom:0}.nav-tabs-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:hover,.nav-tabs-justified>.active>a:focus{border:1px solid #ddd}@media (min-width:768px){.nav-tabs-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:hover,.nav-tabs-justified>.active>a:focus{border-bottom-color:#fff}}.tab-content>.tab-pane{display:none;visibility:hidden}.tab-content>.active{display:block;visibility:visible}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-right-radius:0;border-top-left-radius:0}.navbar{position:relative;min-height:50px;margin-bottom:20px;border:1px solid transparent}@media (min-width:768px){.navbar{border-radius:4px}}@media (min-width:768px){.navbar-header{float:left}}.navbar-collapse{overflow-x:visible;padding-right:15px;padding-left:15px;border-top:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.1);box-shadow:inset 0 1px 0 rgba(255,255,255,0.1);-webkit-overflow-scrolling:touch}.navbar-collapse.in{overflow-y:auto}@media (min-width:768px){.navbar-collapse{width:auto;border-top:0;-webkit-box-shadow:none;box-shadow:none}.navbar-collapse.collapse{display:block !important;visibility:visible !important;height:auto !important;padding-bottom:0;overflow:visible !important}.navbar-collapse.in{overflow-y:visible}.navbar-fixed-top .navbar-collapse,.navbar-static-top .navbar-collapse,.navbar-fixed-bottom .navbar-collapse{padding-left:0;padding-right:0}}.navbar-fixed-top .navbar-collapse,.navbar-fixed-bottom .navbar-collapse{max-height:340px}@media (max-device-width:480px) and (orientation:landscape){.navbar-fixed-top .navbar-collapse,.navbar-fixed-bottom .navbar-collapse{max-height:200px}}.container>.navbar-header,.container-fluid>.navbar-header,.container>.navbar-collapse,.container-fluid>.navbar-collapse{margin-right:-15px;margin-left:-15px}@media (min-width:768px){.container>.navbar-header,.container-fluid>.navbar-header,.container>.navbar-collapse,.container-fluid>.navbar-collapse{margin-right:0;margin-left:0}}.navbar-static-top{z-index:1000;border-width:0 0 1px}@media (min-width:768px){.navbar-static-top{border-radius:0}}.navbar-fixed-top,.navbar-fixed-bottom{position:fixed;right:0;left:0;z-index:1030}@media (min-width:768px){.navbar-fixed-top,.navbar-fixed-bottom{border-radius:0}}.navbar-fixed-top{top:0;border-width:0 0 1px}.navbar-fixed-bottom{bottom:0;margin-bottom:0;border-width:1px 0 0}.navbar-brand{float:left;padding:15px 15px;font-size:18px;line-height:20px;height:50px}.navbar-brand:hover,.navbar-brand:focus{text-decoration:none}.navbar-brand>img{display:block}@media (min-width:768px){.navbar>.container .navbar-brand,.navbar>.container-fluid .navbar-brand{margin-left:-15px}}.navbar-toggle{position:relative;float:right;margin-right:15px;padding:9px 10px;margin-top:8px;margin-bottom:8px;background-color:transparent;background-image:none;border:1px solid transparent;border-radius:4px}.navbar-toggle:focus{outline:0}.navbar-toggle .icon-bar{display:block;width:22px;height:2px;border-radius:1px}.navbar-toggle .icon-bar+.icon-bar{margin-top:4px}@media (min-width:768px){.navbar-toggle{display:none}}.navbar-nav{margin:7.5px -15px}.navbar-nav>li>a{padding-top:10px;padding-bottom:10px;line-height:20px}@media (max-width:767px){.navbar-nav .open .dropdown-menu{position:static;float:none;width:auto;margin-top:0;background-color:transparent;border:0;-webkit-box-shadow:none;box-shadow:none}.navbar-nav .open .dropdown-menu>li>a,.navbar-nav .open .dropdown-menu .dropdown-header{padding:5px 15px 5px 25px}.navbar-nav .open .dropdown-menu>li>a{line-height:20px}.navbar-nav .open .dropdown-menu>li>a:hover,.navbar-nav .open .dropdown-menu>li>a:focus{background-image:none}}@media (min-width:768px){.navbar-nav{float:left;margin:0}.navbar-nav>li{float:left}.navbar-nav>li>a{padding-top:15px;padding-bottom:15px}}.navbar-form{margin-left:-15px;margin-right:-15px;padding:10px 15px;border-top:1px solid transparent;border-bottom:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.1);box-shadow:inset 0 1px 0 rgba(255,255,255,0.1),0 1px 0 rgba(255,255,255,0.1);margin-top:8px;margin-bottom:8px}@media (min-width:768px){.navbar-form .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.navbar-form .form-control{display:inline-block;width:auto;vertical-align:middle}.navbar-form .form-control-static{display:inline-block}.navbar-form .input-group{display:inline-table;vertical-align:middle}.navbar-form .input-group .input-group-addon,.navbar-form .input-group .input-group-btn,.navbar-form .input-group .form-control{width:auto}.navbar-form .input-group>.form-control{width:100%}.navbar-form .control-label{margin-bottom:0;vertical-align:middle}.navbar-form .radio,.navbar-form .checkbox{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.navbar-form .radio label,.navbar-form .checkbox label{padding-left:0}.navbar-form .radio input[type="radio"],.navbar-form .checkbox input[type="checkbox"]{position:relative;margin-left:0}.navbar-form .has-feedback .form-control-feedback{top:0}}@media (max-width:767px){.navbar-form .form-group{margin-bottom:5px}.navbar-form .form-group:last-child{margin-bottom:0}}@media (min-width:768px){.navbar-form{width:auto;border:0;margin-left:0;margin-right:0;padding-top:0;padding-bottom:0;-webkit-box-shadow:none;box-shadow:none}}.navbar-nav>li>.dropdown-menu{margin-top:0;border-top-right-radius:0;border-top-left-radius:0}.navbar-fixed-bottom .navbar-nav>li>.dropdown-menu{border-top-right-radius:4px;border-top-left-radius:4px;border-bottom-right-radius:0;border-bottom-left-radius:0}.navbar-btn{margin-top:8px;margin-bottom:8px}.navbar-btn.btn-sm{margin-top:10px;margin-bottom:10px}.navbar-btn.btn-xs{margin-top:14px;margin-bottom:14px}.navbar-text{margin-top:15px;margin-bottom:15px}@media (min-width:768px){.navbar-text{float:left;margin-left:15px;margin-right:15px}}@media (min-width:768px){.navbar-left{float:left !important}.navbar-right{float:right !important;margin-right:-15px}.navbar-right~.navbar-right{margin-right:0}}.navbar-default{background-color:#f8f8f8;border-color:#e7e7e7}.navbar-default .navbar-brand{color:#777}.navbar-default .navbar-brand:hover,.navbar-default .navbar-brand:focus{color:#5e5e5e;background-color:transparent}.navbar-default .navbar-text{color:#777}.navbar-default .navbar-nav>li>a{color:#777}.navbar-default .navbar-nav>li>a:hover,.navbar-default .navbar-nav>li>a:focus{color:#333;background-color:transparent}.navbar-default .navbar-nav>.active>a,.navbar-default .navbar-nav>.active>a:hover,.navbar-default .navbar-nav>.active>a:focus{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav>.disabled>a,.navbar-default .navbar-nav>.disabled>a:hover,.navbar-default .navbar-nav>.disabled>a:focus{color:#ccc;background-color:transparent}.navbar-default .navbar-toggle{border-color:#ddd}.navbar-default .navbar-toggle:hover,.navbar-default .navbar-toggle:focus{background-color:#ddd}.navbar-default .navbar-toggle .icon-bar{background-color:#888}.navbar-default .navbar-collapse,.navbar-default .navbar-form{border-color:#e7e7e7}.navbar-default .navbar-nav>.open>a,.navbar-default .navbar-nav>.open>a:hover,.navbar-default .navbar-nav>.open>a:focus{background-color:#e7e7e7;color:#555}@media (max-width:767px){.navbar-default .navbar-nav .open .dropdown-menu>li>a{color:#777}.navbar-default .navbar-nav .open .dropdown-menu>li>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>li>a:focus{color:#333;background-color:transparent}.navbar-default .navbar-nav .open .dropdown-menu>.active>a,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:focus{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:focus{color:#ccc;background-color:transparent}}.navbar-default .navbar-link{color:#777}.navbar-default .navbar-link:hover{color:#333}.navbar-default .btn-link{color:#777}.navbar-default .btn-link:hover,.navbar-default .btn-link:focus{color:#333}.navbar-default .btn-link[disabled]:hover,fieldset[disabled] .navbar-default .btn-link:hover,.navbar-default .btn-link[disabled]:focus,fieldset[disabled] .navbar-default .btn-link:focus{color:#ccc}.navbar-inverse{background-color:#222;border-color:#080808}.navbar-inverse .navbar-brand{color:#777}.navbar-inverse .navbar-brand:hover,.navbar-inverse .navbar-brand:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-text{color:#777}.navbar-inverse .navbar-nav>li>a{color:#777}.navbar-inverse .navbar-nav>li>a:hover,.navbar-inverse .navbar-nav>li>a:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav>.active>a,.navbar-inverse .navbar-nav>.active>a:hover,.navbar-inverse .navbar-nav>.active>a:focus{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav>.disabled>a,.navbar-inverse .navbar-nav>.disabled>a:hover,.navbar-inverse .navbar-nav>.disabled>a:focus{color:#444;background-color:transparent}.navbar-inverse .navbar-toggle{border-color:#333}.navbar-inverse .navbar-toggle:hover,.navbar-inverse .navbar-toggle:focus{background-color:#333}.navbar-inverse .navbar-toggle .icon-bar{background-color:#fff}.navbar-inverse .navbar-collapse,.navbar-inverse .navbar-form{border-color:#101010}.navbar-inverse .navbar-nav>.open>a,.navbar-inverse .navbar-nav>.open>a:hover,.navbar-inverse .navbar-nav>.open>a:focus{background-color:#080808;color:#fff}@media (max-width:767px){.navbar-inverse .navbar-nav .open .dropdown-menu>.dropdown-header{border-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu .divider{background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a{color:#777}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:focus{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:focus{color:#444;background-color:transparent}}.navbar-inverse .navbar-link{color:#777}.navbar-inverse .navbar-link:hover{color:#fff}.navbar-inverse .btn-link{color:#777}.navbar-inverse .btn-link:hover,.navbar-inverse .btn-link:focus{color:#fff}.navbar-inverse .btn-link[disabled]:hover,fieldset[disabled] .navbar-inverse .btn-link:hover,.navbar-inverse .btn-link[disabled]:focus,fieldset[disabled] .navbar-inverse .btn-link:focus{color:#444}.breadcrumb{padding:8px 15px;margin-bottom:20px;list-style:none;background-color:#f5f5f5;border-radius:4px}.breadcrumb>li{display:inline-block}.breadcrumb>li+li:before{content:"/\00a0";padding:0 5px;color:#ccc}.breadcrumb>.active{color:#777}.pagination{display:inline-block;padding-left:0;margin:20px 0;border-radius:4px}.pagination>li{display:inline}.pagination>li>a,.pagination>li>span{position:relative;float:left;padding:6px 12px;line-height:1.42857143;text-decoration:none;color:#428bca;background-color:#fff;border:1px solid #ddd;margin-left:-1px}.pagination>li:first-child>a,.pagination>li:first-child>span{margin-left:0;border-bottom-left-radius:4px;border-top-left-radius:4px}.pagination>li:last-child>a,.pagination>li:last-child>span{border-bottom-right-radius:4px;border-top-right-radius:4px}.pagination>li>a:hover,.pagination>li>span:hover,.pagination>li>a:focus,.pagination>li>span:focus{color:#2a6496;background-color:#eee;border-color:#ddd}.pagination>.active>a,.pagination>.active>span,.pagination>.active>a:hover,.pagination>.active>span:hover,.pagination>.active>a:focus,.pagination>.active>span:focus{z-index:2;color:#fff;background-color:#428bca;border-color:#428bca;cursor:default}.pagination>.disabled>span,.pagination>.disabled>span:hover,.pagination>.disabled>span:focus,.pagination>.disabled>a,.pagination>.disabled>a:hover,.pagination>.disabled>a:focus{color:#777;background-color:#fff;border-color:#ddd;cursor:not-allowed}.pagination-lg>li>a,.pagination-lg>li>span{padding:10px 16px;font-size:18px}.pagination-lg>li:first-child>a,.pagination-lg>li:first-child>span{border-bottom-left-radius:6px;border-top-left-radius:6px}.pagination-lg>li:last-child>a,.pagination-lg>li:last-child>span{border-bottom-right-radius:6px;border-top-right-radius:6px}.pagination-sm>li>a,.pagination-sm>li>span{padding:5px 10px;font-size:12px}.pagination-sm>li:first-child>a,.pagination-sm>li:first-child>span{border-bottom-left-radius:3px;border-top-left-radius:3px}.pagination-sm>li:last-child>a,.pagination-sm>li:last-child>span{border-bottom-right-radius:3px;border-top-right-radius:3px}.pager{padding-left:0;margin:20px 0;list-style:none;text-align:center}.pager li{display:inline}.pager li>a,.pager li>span{display:inline-block;padding:5px 14px;background-color:#fff;border:1px solid #ddd;border-radius:15px}.pager li>a:hover,.pager li>a:focus{text-decoration:none;background-color:#eee}.pager .next>a,.pager .next>span{float:right}.pager .previous>a,.pager .previous>span{float:left}.pager .disabled>a,.pager .disabled>a:hover,.pager .disabled>a:focus,.pager .disabled>span{color:#777;background-color:#fff;cursor:not-allowed}.label{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:bold;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em}a.label:hover,a.label:focus{color:#fff;text-decoration:none;cursor:pointer}.label:empty{display:none}.btn .label{position:relative;top:-1px}.label-default{background-color:#777}.label-default[href]:hover,.label-default[href]:focus{background-color:#5e5e5e}.label-primary{background-color:#428bca}.label-primary[href]:hover,.label-primary[href]:focus{background-color:#3071a9}.label-success{background-color:#5cb85c}.label-success[href]:hover,.label-success[href]:focus{background-color:#449d44}.label-info{background-color:#5bc0de}.label-info[href]:hover,.label-info[href]:focus{background-color:#31b0d5}.label-warning{background-color:#f0ad4e}.label-warning[href]:hover,.label-warning[href]:focus{background-color:#ec971f}.label-danger{background-color:#d9534f}.label-danger[href]:hover,.label-danger[href]:focus{background-color:#c9302c}.badge{display:inline-block;min-width:10px;padding:3px 7px;font-size:12px;font-weight:bold;color:#fff;line-height:1;vertical-align:baseline;white-space:nowrap;text-align:center;background-color:#777;border-radius:10px}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.btn-xs .badge{top:0;padding:1px 5px}a.badge:hover,a.badge:focus{color:#fff;text-decoration:none;cursor:pointer}.list-group-item.active>.badge,.nav-pills>.active>a>.badge{color:#428bca;background-color:#fff}.list-group-item>.badge{float:right}.list-group-item>.badge+.badge{margin-right:5px}.nav-pills>li>a>.badge{margin-left:3px}.jumbotron{padding:30px 15px;margin-bottom:30px;color:inherit;background-color:#eee}.jumbotron h1,.jumbotron .h1{color:inherit}.jumbotron p{margin-bottom:15px;font-size:21px;font-weight:200}.jumbotron>hr{border-top-color:#d5d5d5}.container .jumbotron,.container-fluid .jumbotron{border-radius:6px}.jumbotron .container{max-width:100%}@media screen and (min-width:768px){.jumbotron{padding:48px 0}.container .jumbotron,.container-fluid .jumbotron{padding-left:60px;padding-right:60px}.jumbotron h1,.jumbotron .h1{font-size:63px}}.thumbnail{display:block;padding:4px;margin-bottom:20px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:border .2s ease-in-out;-o-transition:border .2s ease-in-out;transition:border .2s ease-in-out}.thumbnail>img,.thumbnail a>img{margin-left:auto;margin-right:auto}a.thumbnail:hover,a.thumbnail:focus,a.thumbnail.active{border-color:#428bca}.thumbnail .caption{padding:9px;color:#333}.alert{padding:15px;margin-bottom:20px;border:1px solid transparent;border-radius:4px}.alert h4{margin-top:0;color:inherit}.alert .alert-link{font-weight:bold}.alert>p,.alert>ul{margin-bottom:0}.alert>p+p{margin-top:5px}.alert-dismissable,.alert-dismissible{padding-right:35px}.alert-dismissable .close,.alert-dismissible .close{position:relative;top:-2px;right:-21px;color:inherit}.alert-success{background-color:#dff0d8;border-color:#d6e9c6;color:#3c763d}.alert-success hr{border-top-color:#c9e2b3}.alert-success .alert-link{color:#2b542c}.alert-info{background-color:#d9edf7;border-color:#bce8f1;color:#31708f}.alert-info hr{border-top-color:#a6e1ec}.alert-info .alert-link{color:#245269}.alert-warning{background-color:#fcf8e3;border-color:#faebcc;color:#8a6d3b}.alert-warning hr{border-top-color:#f7e1b5}.alert-warning .alert-link{color:#66512c}.alert-danger{background-color:#f2dede;border-color:#ebccd1;color:#a94442}.alert-danger hr{border-top-color:#e4b9c0}.alert-danger .alert-link{color:#843534}@-webkit-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@-o-keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}@keyframes progress-bar-stripes{from{background-position:40px 0}to{background-position:0 0}}.progress{overflow:hidden;height:20px;margin-bottom:20px;background-color:#f5f5f5;border-radius:4px;-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,0.1);box-shadow:inset 0 1px 2px rgba(0,0,0,0.1)}.progress-bar{float:left;width:0%;height:100%;font-size:12px;line-height:20px;color:#fff;text-align:center;background-color:#428bca;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,0.15);box-shadow:inset 0 -1px 0 rgba(0,0,0,0.15);-webkit-transition:width .6s ease;-o-transition:width .6s ease;transition:width .6s ease}.progress-striped .progress-bar,.progress-bar-striped{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);-webkit-background-size:40px 40px;background-size:40px 40px}.progress.active .progress-bar,.progress-bar.active{-webkit-animation:progress-bar-stripes 2s linear infinite;-o-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}.progress-bar-success{background-color:#5cb85c}.progress-striped .progress-bar-success{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent)}.progress-bar-info{background-color:#5bc0de}.progress-striped .progress-bar-info{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent)}.progress-bar-warning{background-color:#f0ad4e}.progress-striped .progress-bar-warning{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent)}.progress-bar-danger{background-color:#d9534f}.progress-striped .progress-bar-danger{background-image:-webkit-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:-o-linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent);background-image:linear-gradient(45deg, rgba(255,255,255,0.15) 25%, transparent 25%, transparent 50%, rgba(255,255,255,0.15) 50%, rgba(255,255,255,0.15) 75%, transparent 75%, transparent)}.media{margin-top:15px}.media:first-child{margin-top:0}.media-right,.media>.pull-right{padding-left:10px}.media-left,.media>.pull-left{padding-right:10px}.media-left,.media-right,.media-body{display:table-cell;vertical-align:top}.media-middle{vertical-align:middle}.media-bottom{vertical-align:bottom}.media-heading{margin-top:0;margin-bottom:5px}.media-list{padding-left:0;list-style:none}.list-group{margin-bottom:20px;padding-left:0}.list-group-item{position:relative;display:block;padding:10px 15px;margin-bottom:-1px;background-color:#fff;border:1px solid #ddd}.list-group-item:first-child{border-top-right-radius:4px;border-top-left-radius:4px}.list-group-item:last-child{margin-bottom:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}a.list-group-item{color:#555}a.list-group-item .list-group-item-heading{color:#333}a.list-group-item:hover,a.list-group-item:focus{text-decoration:none;color:#555;background-color:#f5f5f5}.list-group-item.disabled,.list-group-item.disabled:hover,.list-group-item.disabled:focus{background-color:#eee;color:#777;cursor:not-allowed}.list-group-item.disabled .list-group-item-heading,.list-group-item.disabled:hover .list-group-item-heading,.list-group-item.disabled:focus .list-group-item-heading{color:inherit}.list-group-item.disabled .list-group-item-text,.list-group-item.disabled:hover .list-group-item-text,.list-group-item.disabled:focus .list-group-item-text{color:#777}.list-group-item.active,.list-group-item.active:hover,.list-group-item.active:focus{z-index:2;color:#fff;background-color:#428bca;border-color:#428bca}.list-group-item.active .list-group-item-heading,.list-group-item.active:hover .list-group-item-heading,.list-group-item.active:focus .list-group-item-heading,.list-group-item.active .list-group-item-heading>small,.list-group-item.active:hover .list-group-item-heading>small,.list-group-item.active:focus .list-group-item-heading>small,.list-group-item.active .list-group-item-heading>.small,.list-group-item.active:hover .list-group-item-heading>.small,.list-group-item.active:focus .list-group-item-heading>.small{color:inherit}.list-group-item.active .list-group-item-text,.list-group-item.active:hover .list-group-item-text,.list-group-item.active:focus .list-group-item-text{color:#e1edf7}.list-group-item-success{color:#3c763d;background-color:#dff0d8}a.list-group-item-success{color:#3c763d}a.list-group-item-success .list-group-item-heading{color:inherit}a.list-group-item-success:hover,a.list-group-item-success:focus{color:#3c763d;background-color:#d0e9c6}a.list-group-item-success.active,a.list-group-item-success.active:hover,a.list-group-item-success.active:focus{color:#fff;background-color:#3c763d;border-color:#3c763d}.list-group-item-info{color:#31708f;background-color:#d9edf7}a.list-group-item-info{color:#31708f}a.list-group-item-info .list-group-item-heading{color:inherit}a.list-group-item-info:hover,a.list-group-item-info:focus{color:#31708f;background-color:#c4e3f3}a.list-group-item-info.active,a.list-group-item-info.active:hover,a.list-group-item-info.active:focus{color:#fff;background-color:#31708f;border-color:#31708f}.list-group-item-warning{color:#8a6d3b;background-color:#fcf8e3}a.list-group-item-warning{color:#8a6d3b}a.list-group-item-warning .list-group-item-heading{color:inherit}a.list-group-item-warning:hover,a.list-group-item-warning:focus{color:#8a6d3b;background-color:#faf2cc}a.list-group-item-warning.active,a.list-group-item-warning.active:hover,a.list-group-item-warning.active:focus{color:#fff;background-color:#8a6d3b;border-color:#8a6d3b}.list-group-item-danger{color:#a94442;background-color:#f2dede}a.list-group-item-danger{color:#a94442}a.list-group-item-danger .list-group-item-heading{color:inherit}a.list-group-item-danger:hover,a.list-group-item-danger:focus{color:#a94442;background-color:#ebcccc}a.list-group-item-danger.active,a.list-group-item-danger.active:hover,a.list-group-item-danger.active:focus{color:#fff;background-color:#a94442;border-color:#a94442}.list-group-item-heading{margin-top:0;margin-bottom:5px}.list-group-item-text{margin-bottom:0;line-height:1.3}.panel{margin-bottom:20px;background-color:#fff;border:1px solid transparent;border-radius:4px;-webkit-box-shadow:0 1px 1px rgba(0,0,0,0.05);box-shadow:0 1px 1px rgba(0,0,0,0.05)}.panel-body{padding:15px}.panel-heading{padding:10px 15px;border-bottom:1px solid transparent;border-top-right-radius:3px;border-top-left-radius:3px}.panel-heading>.dropdown .dropdown-toggle{color:inherit}.panel-title{margin-top:0;margin-bottom:0;font-size:16px;color:inherit}.panel-title>a{color:inherit}.panel-footer{padding:10px 15px;background-color:#f5f5f5;border-top:1px solid #ddd;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.list-group,.panel>.panel-collapse>.list-group{margin-bottom:0}.panel>.list-group .list-group-item,.panel>.panel-collapse>.list-group .list-group-item{border-width:1px 0;border-radius:0}.panel>.list-group:first-child .list-group-item:first-child,.panel>.panel-collapse>.list-group:first-child .list-group-item:first-child{border-top:0;border-top-right-radius:3px;border-top-left-radius:3px}.panel>.list-group:last-child .list-group-item:last-child,.panel>.panel-collapse>.list-group:last-child .list-group-item:last-child{border-bottom:0;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel-heading+.list-group .list-group-item:first-child{border-top-width:0}.list-group+.panel-footer{border-top-width:0}.panel>.table,.panel>.table-responsive>.table,.panel>.panel-collapse>.table{margin-bottom:0}.panel>.table caption,.panel>.table-responsive>.table caption,.panel>.panel-collapse>.table caption{padding-left:15px;padding-right:15px}.panel>.table:first-child,.panel>.table-responsive:first-child>.table:first-child{border-top-right-radius:3px;border-top-left-radius:3px}.panel>.table:first-child>thead:first-child>tr:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table:first-child>thead:first-child>tr:first-child th:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:first-child{border-top-left-radius:3px}.panel>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table:first-child>thead:first-child>tr:first-child th:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:last-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:last-child{border-top-right-radius:3px}.panel>.table:last-child,.panel>.table-responsive:last-child>.table:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table:last-child>tbody:last-child>tr:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child{border-bottom-left-radius:3px;border-bottom-right-radius:3px}.panel>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:first-child{border-bottom-left-radius:3px}.panel>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:last-child{border-bottom-right-radius:3px}.panel>.panel-body+.table,.panel>.panel-body+.table-responsive,.panel>.table+.panel-body,.panel>.table-responsive+.panel-body{border-top:1px solid #ddd}.panel>.table>tbody:first-child>tr:first-child th,.panel>.table>tbody:first-child>tr:first-child td{border-top:0}.panel>.table-bordered,.panel>.table-responsive>.table-bordered{border:0}.panel>.table-bordered>thead>tr>th:first-child,.panel>.table-responsive>.table-bordered>thead>tr>th:first-child,.panel>.table-bordered>tbody>tr>th:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:first-child,.panel>.table-bordered>tfoot>tr>th:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:first-child,.panel>.table-bordered>thead>tr>td:first-child,.panel>.table-responsive>.table-bordered>thead>tr>td:first-child,.panel>.table-bordered>tbody>tr>td:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:first-child,.panel>.table-bordered>tfoot>tr>td:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:first-child{border-left:0}.panel>.table-bordered>thead>tr>th:last-child,.panel>.table-responsive>.table-bordered>thead>tr>th:last-child,.panel>.table-bordered>tbody>tr>th:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:last-child,.panel>.table-bordered>tfoot>tr>th:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:last-child,.panel>.table-bordered>thead>tr>td:last-child,.panel>.table-responsive>.table-bordered>thead>tr>td:last-child,.panel>.table-bordered>tbody>tr>td:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:last-child,.panel>.table-bordered>tfoot>tr>td:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:last-child{border-right:0}.panel>.table-bordered>thead>tr:first-child>td,.panel>.table-responsive>.table-bordered>thead>tr:first-child>td,.panel>.table-bordered>tbody>tr:first-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>td,.panel>.table-bordered>thead>tr:first-child>th,.panel>.table-responsive>.table-bordered>thead>tr:first-child>th,.panel>.table-bordered>tbody>tr:first-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>th{border-bottom:0}.panel>.table-bordered>tbody>tr:last-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>td,.panel>.table-bordered>tfoot>tr:last-child>td,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>td,.panel>.table-bordered>tbody>tr:last-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>th,.panel>.table-bordered>tfoot>tr:last-child>th,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>th{border-bottom:0}.panel>.table-responsive{border:0;margin-bottom:0}.panel-group{margin-bottom:20px}.panel-group .panel{margin-bottom:0;border-radius:4px}.panel-group .panel+.panel{margin-top:5px}.panel-group .panel-heading{border-bottom:0}.panel-group .panel-heading+.panel-collapse>.panel-body,.panel-group .panel-heading+.panel-collapse>.list-group{border-top:1px solid #ddd}.panel-group .panel-footer{border-top:0}.panel-group .panel-footer+.panel-collapse .panel-body{border-bottom:1px solid #ddd}.panel-default{border-color:#ddd}.panel-default>.panel-heading{color:#333;background-color:#f5f5f5;border-color:#ddd}.panel-default>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ddd}.panel-default>.panel-heading .badge{color:#f5f5f5;background-color:#333}.panel-default>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ddd}.panel-primary{border-color:#428bca}.panel-primary>.panel-heading{color:#fff;background-color:#428bca;border-color:#428bca}.panel-primary>.panel-heading+.panel-collapse>.panel-body{border-top-color:#428bca}.panel-primary>.panel-heading .badge{color:#428bca;background-color:#fff}.panel-primary>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#428bca}.panel-success{border-color:#d6e9c6}.panel-success>.panel-heading{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.panel-success>.panel-heading+.panel-collapse>.panel-body{border-top-color:#d6e9c6}.panel-success>.panel-heading .badge{color:#dff0d8;background-color:#3c763d}.panel-success>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#d6e9c6}.panel-info{border-color:#bce8f1}.panel-info>.panel-heading{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.panel-info>.panel-heading+.panel-collapse>.panel-body{border-top-color:#bce8f1}.panel-info>.panel-heading .badge{color:#d9edf7;background-color:#31708f}.panel-info>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#bce8f1}.panel-warning{border-color:#faebcc}.panel-warning>.panel-heading{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.panel-warning>.panel-heading+.panel-collapse>.panel-body{border-top-color:#faebcc}.panel-warning>.panel-heading .badge{color:#fcf8e3;background-color:#8a6d3b}.panel-warning>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#faebcc}.panel-danger{border-color:#ebccd1}.panel-danger>.panel-heading{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.panel-danger>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ebccd1}.panel-danger>.panel-heading .badge{color:#f2dede;background-color:#a94442}.panel-danger>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ebccd1}.embed-responsive{position:relative;display:block;height:0;padding:0;overflow:hidden}.embed-responsive .embed-responsive-item,.embed-responsive iframe,.embed-responsive embed,.embed-responsive object,.embed-responsive video{position:absolute;top:0;left:0;bottom:0;height:100%;width:100%;border:0}.embed-responsive.embed-responsive-16by9{padding-bottom:56.25%}.embed-responsive.embed-responsive-4by3{padding-bottom:75%}.well{min-height:20px;padding:19px;margin-bottom:20px;background-color:#f5f5f5;border:1px solid #e3e3e3;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,0.05);box-shadow:inset 0 1px 1px rgba(0,0,0,0.05)}.well blockquote{border-color:#ddd;border-color:rgba(0,0,0,0.15)}.well-lg{padding:24px;border-radius:6px}.well-sm{padding:9px;border-radius:3px}.close{float:right;font-size:21px;font-weight:bold;line-height:1;color:#000;text-shadow:0 1px 0 #fff;opacity:.2;filter:alpha(opacity=20)}.close:hover,.close:focus{color:#000;text-decoration:none;cursor:pointer;opacity:.5;filter:alpha(opacity=50)}button.close{padding:0;cursor:pointer;background:transparent;border:0;-webkit-appearance:none}.modal-open{overflow:hidden}.modal{display:none;overflow:hidden;position:fixed;top:0;right:0;bottom:0;left:0;z-index:1040;-webkit-overflow-scrolling:touch;outline:0}.modal.fade .modal-dialog{-webkit-transform:translate(0, -25%);-ms-transform:translate(0, -25%);-o-transform:translate(0, -25%);transform:translate(0, -25%);-webkit-transition:-webkit-transform 0.3s ease-out;-o-transition:-o-transform 0.3s ease-out;transition:transform 0.3s ease-out}.modal.in .modal-dialog{-webkit-transform:translate(0, 0);-ms-transform:translate(0, 0);-o-transform:translate(0, 0);transform:translate(0, 0)}.modal-open .modal{overflow-x:hidden;overflow-y:auto}.modal-dialog{position:relative;width:auto;margin:10px}.modal-content{position:relative;background-color:#fff;border:1px solid #999;border:1px solid rgba(0,0,0,0.2);border-radius:6px;-webkit-box-shadow:0 3px 9px rgba(0,0,0,0.5);box-shadow:0 3px 9px rgba(0,0,0,0.5);-webkit-background-clip:padding-box;background-clip:padding-box;outline:0}.modal-backdrop{position:absolute;top:0;right:0;left:0;background-color:#000}.modal-backdrop.fade{opacity:0;filter:alpha(opacity=0)}.modal-backdrop.in{opacity:.5;filter:alpha(opacity=50)}.modal-header{padding:15px;border-bottom:1px solid #e5e5e5;min-height:16.42857143px}.modal-header .close{margin-top:-2px}.modal-title{margin:0;line-height:1.42857143}.modal-body{position:relative;padding:15px}.modal-footer{padding:15px;text-align:right;border-top:1px solid #e5e5e5}.modal-footer .btn+.btn{margin-left:5px;margin-bottom:0}.modal-footer .btn-group .btn+.btn{margin-left:-1px}.modal-footer .btn-block+.btn-block{margin-left:0}.modal-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}@media (min-width:768px){.modal-dialog{width:600px;margin:30px auto}.modal-content{-webkit-box-shadow:0 5px 15px rgba(0,0,0,0.5);box-shadow:0 5px 15px rgba(0,0,0,0.5)}.modal-sm{width:300px}}@media (min-width:992px){.modal-lg{width:900px}}.tooltip{position:absolute;z-index:1070;display:block;visibility:visible;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:12px;font-weight:normal;line-height:1.4;opacity:0;filter:alpha(opacity=0)}.tooltip.in{opacity:.9;filter:alpha(opacity=90)}.tooltip.top{margin-top:-3px;padding:5px 0}.tooltip.right{margin-left:3px;padding:0 5px}.tooltip.bottom{margin-top:3px;padding:5px 0}.tooltip.left{margin-left:-3px;padding:0 5px}.tooltip-inner{max-width:200px;padding:3px 8px;color:#fff;text-align:center;text-decoration:none;background-color:#000;border-radius:4px}.tooltip-arrow{position:absolute;width:0;height:0;border-color:transparent;border-style:solid}.tooltip.top .tooltip-arrow{bottom:0;left:50%;margin-left:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-left .tooltip-arrow{bottom:0;right:5px;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-right .tooltip-arrow{bottom:0;left:5px;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.right .tooltip-arrow{top:50%;left:0;margin-top:-5px;border-width:5px 5px 5px 0;border-right-color:#000}.tooltip.left .tooltip-arrow{top:50%;right:0;margin-top:-5px;border-width:5px 0 5px 5px;border-left-color:#000}.tooltip.bottom .tooltip-arrow{top:0;left:50%;margin-left:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-left .tooltip-arrow{top:0;right:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-right .tooltip-arrow{top:0;left:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.popover{position:absolute;top:0;left:0;z-index:1060;display:none;max-width:276px;padding:1px;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:14px;font-weight:normal;line-height:1.42857143;text-align:left;background-color:#fff;-webkit-background-clip:padding-box;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,0.2);border-radius:6px;-webkit-box-shadow:0 5px 10px rgba(0,0,0,0.2);box-shadow:0 5px 10px rgba(0,0,0,0.2);white-space:normal}.popover.top{margin-top:-10px}.popover.right{margin-left:10px}.popover.bottom{margin-top:10px}.popover.left{margin-left:-10px}.popover-title{margin:0;padding:8px 14px;font-size:14px;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-radius:5px 5px 0 0}.popover-content{padding:9px 14px}.popover>.arrow,.popover>.arrow:after{position:absolute;display:block;width:0;height:0;border-color:transparent;border-style:solid}.popover>.arrow{border-width:11px}.popover>.arrow:after{border-width:10px;content:""}.popover.top>.arrow{left:50%;margin-left:-11px;border-bottom-width:0;border-top-color:#999;border-top-color:rgba(0,0,0,0.25);bottom:-11px}.popover.top>.arrow:after{content:" ";bottom:1px;margin-left:-10px;border-bottom-width:0;border-top-color:#fff}.popover.right>.arrow{top:50%;left:-11px;margin-top:-11px;border-left-width:0;border-right-color:#999;border-right-color:rgba(0,0,0,0.25)}.popover.right>.arrow:after{content:" ";left:1px;bottom:-10px;border-left-width:0;border-right-color:#fff}.popover.bottom>.arrow{left:50%;margin-left:-11px;border-top-width:0;border-bottom-color:#999;border-bottom-color:rgba(0,0,0,0.25);top:-11px}.popover.bottom>.arrow:after{content:" ";top:1px;margin-left:-10px;border-top-width:0;border-bottom-color:#fff}.popover.left>.arrow{top:50%;right:-11px;margin-top:-11px;border-right-width:0;border-left-color:#999;border-left-color:rgba(0,0,0,0.25)}.popover.left>.arrow:after{content:" ";right:1px;border-right-width:0;border-left-color:#fff;bottom:-10px}.carousel{position:relative}.carousel-inner{position:relative;overflow:hidden;width:100%}.carousel-inner>.item{display:none;position:relative;-webkit-transition:.6s ease-in-out left;-o-transition:.6s ease-in-out left;transition:.6s ease-in-out left}.carousel-inner>.item>img,.carousel-inner>.item>a>img{line-height:1}@media all and (transform-3d),(-webkit-transform-3d){.carousel-inner>.item{-webkit-transition:-webkit-transform .6s ease-in-out;-o-transition:-o-transform .6s ease-in-out;transition:transform .6s ease-in-out;-webkit-backface-visibility:hidden;backface-visibility:hidden;-webkit-perspective:1000;perspective:1000}.carousel-inner>.item.next,.carousel-inner>.item.active.right{-webkit-transform:translate3d(100%, 0, 0);transform:translate3d(100%, 0, 0);left:0}.carousel-inner>.item.prev,.carousel-inner>.item.active.left{-webkit-transform:translate3d(-100%, 0, 0);transform:translate3d(-100%, 0, 0);left:0}.carousel-inner>.item.next.left,.carousel-inner>.item.prev.right,.carousel-inner>.item.active{-webkit-transform:translate3d(0, 0, 0);transform:translate3d(0, 0, 0);left:0}}.carousel-inner>.active,.carousel-inner>.next,.carousel-inner>.prev{display:block}.carousel-inner>.active{left:0}.carousel-inner>.next,.carousel-inner>.prev{position:absolute;top:0;width:100%}.carousel-inner>.next{left:100%}.carousel-inner>.prev{left:-100%}.carousel-inner>.next.left,.carousel-inner>.prev.right{left:0}.carousel-inner>.active.left{left:-100%}.carousel-inner>.active.right{left:100%}.carousel-control{position:absolute;top:0;left:0;bottom:0;width:15%;opacity:.5;filter:alpha(opacity=50);font-size:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,0.6)}.carousel-control.left{background-image:-webkit-linear-gradient(left, rgba(0,0,0,0.5) 0, rgba(0,0,0,0.0001) 100%);background-image:-o-linear-gradient(left, rgba(0,0,0,0.5) 0, rgba(0,0,0,0.0001) 100%);background-image:-webkit-gradient(linear, left top, right top, color-stop(0, rgba(0,0,0,0.5)), to(rgba(0,0,0,0.0001)));background-image:linear-gradient(to right, rgba(0,0,0,0.5) 0, rgba(0,0,0,0.0001) 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#80000000', endColorstr='#00000000', GradientType=1)}.carousel-control.right{left:auto;right:0;background-image:-webkit-linear-gradient(left, rgba(0,0,0,0.0001) 0, rgba(0,0,0,0.5) 100%);background-image:-o-linear-gradient(left, rgba(0,0,0,0.0001) 0, rgba(0,0,0,0.5) 100%);background-image:-webkit-gradient(linear, left top, right top, color-stop(0, rgba(0,0,0,0.0001)), to(rgba(0,0,0,0.5)));background-image:linear-gradient(to right, rgba(0,0,0,0.0001) 0, rgba(0,0,0,0.5) 100%);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#00000000', endColorstr='#80000000', GradientType=1)}.carousel-control:hover,.carousel-control:focus{outline:0;color:#fff;text-decoration:none;opacity:.9;filter:alpha(opacity=90)}.carousel-control .icon-prev,.carousel-control .icon-next,.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right{position:absolute;top:50%;z-index:5;display:inline-block}.carousel-control .icon-prev,.carousel-control .glyphicon-chevron-left{left:50%;margin-left:-10px}.carousel-control .icon-next,.carousel-control .glyphicon-chevron-right{right:50%;margin-right:-10px}.carousel-control .icon-prev,.carousel-control .icon-next{width:20px;height:20px;margin-top:-10px;font-family:serif}.carousel-control .icon-prev:before{content:'\2039'}.carousel-control .icon-next:before{content:'\203a'}.carousel-indicators{position:absolute;bottom:10px;left:50%;z-index:15;width:60%;margin-left:-30%;padding-left:0;list-style:none;text-align:center}.carousel-indicators li{display:inline-block;width:10px;height:10px;margin:1px;text-indent:-999px;border:1px solid #fff;border-radius:10px;cursor:pointer;background-color:#000 \9;background-color:rgba(0,0,0,0)}.carousel-indicators .active{margin:0;width:12px;height:12px;background-color:#fff}.carousel-caption{position:absolute;left:15%;right:15%;bottom:20px;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,0.6)}.carousel-caption .btn{text-shadow:none}@media screen and (min-width:768px){.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right,.carousel-control .icon-prev,.carousel-control .icon-next{width:30px;height:30px;margin-top:-15px;font-size:30px}.carousel-control .glyphicon-chevron-left,.carousel-control .icon-prev{margin-left:-15px}.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next{margin-right:-15px}.carousel-caption{left:20%;right:20%;padding-bottom:30px}.carousel-indicators{bottom:20px}}.clearfix:before,.clearfix:after,.dl-horizontal dd:before,.dl-horizontal dd:after,.container:before,.container:after,.container-fluid:before,.container-fluid:after,.row:before,.row:after,.form-horizontal .form-group:before,.form-horizontal .form-group:after,.btn-toolbar:before,.btn-toolbar:after,.btn-group-vertical>.btn-group:before,.btn-group-vertical>.btn-group:after,.nav:before,.nav:after,.navbar:before,.navbar:after,.navbar-header:before,.navbar-header:after,.navbar-collapse:before,.navbar-collapse:after,.pager:before,.pager:after,.panel-body:before,.panel-body:after,.modal-footer:before,.modal-footer:after{content:" ";display:table}.clearfix:after,.dl-horizontal dd:after,.container:after,.container-fluid:after,.row:after,.form-horizontal .form-group:after,.btn-toolbar:after,.btn-group-vertical>.btn-group:after,.nav:after,.navbar:after,.navbar-header:after,.navbar-collapse:after,.pager:after,.panel-body:after,.modal-footer:after{clear:both}.center-block{display:block;margin-left:auto;margin-right:auto}.pull-right{float:right !important}.pull-left{float:left !important}.hide{display:none !important}.show{display:block !important}.invisible{visibility:hidden}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.hidden{display:none !important;visibility:hidden !important}.affix{position:fixed}@-ms-viewport{width:device-width}.visible-xs,.visible-sm,.visible-md,.visible-lg{display:none !important}.visible-xs-block,.visible-xs-inline,.visible-xs-inline-block,.visible-sm-block,.visible-sm-inline,.visible-sm-inline-block,.visible-md-block,.visible-md-inline,.visible-md-inline-block,.visible-lg-block,.visible-lg-inline,.visible-lg-inline-block{display:none !important}@media (max-width:767px){.visible-xs{display:block !important}table.visible-xs{display:table}tr.visible-xs{display:table-row !important}th.visible-xs,td.visible-xs{display:table-cell !important}}@media (max-width:767px){.visible-xs-block{display:block !important}}@media (max-width:767px){.visible-xs-inline{display:inline !important}}@media (max-width:767px){.visible-xs-inline-block{display:inline-block !important}}@media (min-width:768px) and (max-width:991px){.visible-sm{display:block !important}table.visible-sm{display:table}tr.visible-sm{display:table-row !important}th.visible-sm,td.visible-sm{display:table-cell !important}}@media (min-width:768px) and (max-width:991px){.visible-sm-block{display:block !important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline{display:inline !important}}@media (min-width:768px) and (max-width:991px){.visible-sm-inline-block{display:inline-block !important}}@media (min-width:992px) and (max-width:1199px){.visible-md{display:block !important}table.visible-md{display:table}tr.visible-md{display:table-row !important}th.visible-md,td.visible-md{display:table-cell !important}}@media (min-width:992px) and (max-width:1199px){.visible-md-block{display:block !important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline{display:inline !important}}@media (min-width:992px) and (max-width:1199px){.visible-md-inline-block{display:inline-block !important}}@media (min-width:1200px){.visible-lg{display:block !important}table.visible-lg{display:table}tr.visible-lg{display:table-row !important}th.visible-lg,td.visible-lg{display:table-cell !important}}@media (min-width:1200px){.visible-lg-block{display:block !important}}@media (min-width:1200px){.visible-lg-inline{display:inline !important}}@media (min-width:1200px){.visible-lg-inline-block{display:inline-block !important}}@media (max-width:767px){.hidden-xs{display:none !important}}@media (min-width:768px) and (max-width:991px){.hidden-sm{display:none !important}}@media (min-width:992px) and (max-width:1199px){.hidden-md{display:none !important}}@media (min-width:1200px){.hidden-lg{display:none !important}}.visible-print{display:none !important}@media print{.visible-print{display:block !important}table.visible-print{display:table}tr.visible-print{display:table-row !important}th.visible-print,td.visible-print{display:table-cell !important}}.visible-print-block{display:none !important}@media print{.visible-print-block{display:block !important}}.visible-print-inline{display:none !important}@media print{.visible-print-inline{display:inline !important}}.visible-print-inline-block{display:none !important}@media print{.visible-print-inline-block{display:inline-block !important}}@media print{.hidden-print{display:none !important}} \ No newline at end of file diff --git a/docs/API/API/css/main.css b/docs/API/API/css/main.css deleted file mode 100644 index 17608f606..000000000 --- a/docs/API/API/css/main.css +++ /dev/null @@ -1,214 +0,0 @@ -/* -Copyright (c) 2009 Vladimir Kolesnikov - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ - -a { - color: #00F; - text-decoration: none; -} - -a:hover { - color: #77F; - text-decoration: underline; -} - -body, td, p { - font-family: "Bitstream Vera Sans", Verdana, Arial, Helvetica, sans-serif; - background: #FFF; - color: #000; - margin: 0px; - font-size: small; -} - -p { - margin-top: 0.5em; - margin-bottom: 0.5em; -} - -#content { - margin: 2em; - margin-left: 3.5em; - margin-right: 3.5em; -} - -#description p { - margin-bottom: 0.5em; -} - -.sectiontitle { - margin-top: 1em; - margin-bottom: 1em; - padding: 0.5em; - padding-left: 2em; - background: #005; - color: #FFF; - font-weight: bold; -} - -.attr-rw { - padding-left: 1em; - padding-right: 1em; - text-align: center; - color: #055; -} - -.attr-name { - font-weight: bold; -} - -.attr-desc { -} - -.attr-desc p { - margin-top: 0; -} - -.attr-value { - font-family: monospace; -} - -.file-title-prefix { - font-size: large; -} - -.file-title { - font-size: large; - font-weight: bold; - background: #005; - color: #FFF; -} - -.banner { - background: #005; - color: #FFF; - border: 1px solid black; - padding: 1em; -} - -.banner td { - background: transparent; - color: #FFF; -} - -h1 a, h2 a, .sectiontitle a, .banner a { - color: #FF0; -} - -h1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover { - color: #FF7; -} - -.dyn-source { - display: none; - background: #fffde8; - color: #000; - border: #ffe0bb dotted 1px; - margin: 0.5em 2em 0.5em 2em; - padding: 0.5em; -} - -.dyn-source .cmt { - color: #00F; - font-style: italic; -} - -.dyn-source .kw { - color: #070; - font-weight: bold; -} - -.method { - margin-left: 1em; - margin-right: 1em; - margin-bottom: 1em; -} - -.description pre { - padding: 0.5em; - border: #ffe0bb dotted 1px; - background: #fffde8; -} - -.method .title { - font-family: monospace; - font-size: large; - border-bottom: 1px dashed black; - margin-bottom: 0.3em; - padding-bottom: 0.1em; -} - -.method .description, .method .sourcecode { - margin-left: 1em; -} - -.description p, .sourcecode p { - margin-bottom: 0.5em; -} - -.method .sourcecode p.source-link { - text-indent: 0em; - margin-top: 0.5em; -} - -.method .aka { - margin-top: 0.3em; - margin-left: 1em; - font-style: italic; - text-indent: 2em; -} - -h1 { - padding: 1em; - margin-left: -1.5em; - font-size: x-large; - font-weight: bold; - color: #FFF; - background: #007; -} - -h2 { - padding: 0.5em 1em 0.5em 1em; - margin-left: -1.5em; - font-size: large; - font-weight: bold; - color: #FFF; - background: #009; -} - -h3, h4, h5, h6 { - color: #220088; - border-bottom: #5522bb solid 1px; -} - -.sourcecode > pre { - padding: 0.5em; - border: 1px dotted black; - background: #FFE; -} - -dt { - font-weight: bold -} - -dd { - margin-bottom: 0.7em; -} \ No newline at end of file diff --git a/docs/API/API/css/panel.css b/docs/API/API/css/panel.css deleted file mode 100644 index b7565b2f6..000000000 --- a/docs/API/API/css/panel.css +++ /dev/null @@ -1,427 +0,0 @@ -/* -Copyright (c) 2009 Vladimir Kolesnikov - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ - -/* Panel (begin) */ - .panel - { - position: absolute; - width: 100%; - height: 100%; - top: 0; - left: 0; - background: #FFF; - z-index: 2; - font-family: "Helvetica Neue", "Arial", sans-serif; - //zoom: 1; - } - - .panel_tree .results, - .panel_results .tree - { - display: none; - } - - /* Header with search box (begin) */ - .panel .header - { - width: 100%; - height: 59px; - border-bottom: 1px solid #666; - position: relative; - left: 0; top: 0; - background: #e8e8e8; - } - - .panel .header div.nav - { - padding-top: 7px; - margin: 0 7px; - } - - .panel .header table - { - height: 29px; - width: 100%; - } - - .panel .header table td - { - vertical-align: middle; - text-align: middle; - } - - .panel .header form - { - float: right; - text-align: bottom; - } - - .panel .header h1 - { - float: left; - font-size: 14px; - font-weight: normal; - color: #777; - text-align: bottom; - } - - .panel .header input - { - width: 100%; - box-sizing: border-box; - -moz-box-sizing: border-box; - -webkit-box-sizing: border-box; - display: inline-block; - -webkit-appearance: searchfield; - height: 22px; - //height: auto; - } - - /* Header with search box (end) */ - - - /* Results (begin) */ - .panel .result - { - position: absolute; - top: 60px; - bottom: 0; - left: 0; - width: 100%; - //height: expression((this.parentNode.offsetHeight - 31)); - overflow-y: scroll; - overflow-x: hidden; - -overflow-y: hidden; - background: #EDF3FE url(http://github.com/i/results_bg.png); - z-index: 2; - //zoom:1; - } - - .panel .result ul - { - font-size: 0.8em; - width: 100%; - background: #EDF3FE url(http://github.com/i/results_bg.png); - //zoom:1; - } - - .panel .result ul li - { - height: 46px; - -height: 50px; - //display: inline; - //width: 100%; - //zoom: 1; - overflow: hidden; - padding: 4px 10px 0 10px; - cursor: pointer; - } - - .panel .result ul li h1 - { - font-size: 13px; - font-weight: normal; - color: #333; - margin-bottom: 2px; - white-space: nowrap; - } - - .panel .result ul li p - { - font-size: 11px; - color: #333; - margin-bottom: 2px; - white-space: nowrap; - } - - .panel .result ul li h1 i, - .panel .result ul li p.snippet - { - color: #999; - } - - .panel .result ul li b - { - color: #000; - } - - .panel .result ul li.current - { - background: #3875D7; - } - - .panel .result ul li.current h1, - .panel .result ul li.current p - { - color: #DDD; - } - - .panel .result ul li.current h1 i, - .panel .result ul li.current p.snippet - { - color: #AAA; - } - - .panel .result ul li.current b - { - color: #FFF; - } - - - .panel .result ul li:hover, - .panel .result ul li.selected - { - background: #d0d0d0; - } - - .panel .result ul li.current:hover - { - background: #2965C0; - } - - .panel .result ul li .badge - { - margin-right: 0.4em; - margin-left: -0.2em; - padding: 0 0.2em; - color: #000; - } - - .panel .result ul li .badge_1 - { - background: #ACDBF4; - } - - .panel .result ul li.current .badge_1 - { - background: #97BFD7; - } - - .panel .result ul li .badge_2 - { - background: #ACF3C3; - } - - .panel .result ul li.current .badge_2 - { - background: #98D7AC; - } - - .panel .result ul li .badge_3 - { - background: #E0F3AC; - } - - .panel .result ul li.current .badge_3 - { - background: #C4D798; - } - - .panel .result ul li .badge_4 - { - background: #D7CA98; - } - - .panel .result ul li.current .badge_4 - { - background: #A6B0AC; - } - - .panel .result ul li .badge_5 - { - background: #F3C8AC; - } - - .panel .result ul li.current .badge_5 - { - background: #D7B198; - } - - .panel .result ul li .badge_6 - { - background: #F3ACC3; - } - - .panel .result ul li.current .badge_6 - { - background: #D798AB; - } - - /* Results (end) */ - - /* Tree (begin) */ /**/ - .panel .tree - { - position: absolute; - top: 60px; - bottom: 0; - left: 0; - width: 100%; - //zoom: 1; - //height: expression((this.parentNode.offsetHeight - 31)); - overflow-y: scroll; - overflow-x: hidden; - -overflow-y: hidden; - background: #EDF3FE url(http://github.com/i/tree_bg.png); - z-index: 30; - } - - .panel .tree ul - { - background: #EDF3FE url(http://github.com/i/tree_bg.png); - } - - .panel .tree li - { - cursor: pointer; - overflow: hidden; - //height: 23px; - //display: inline; - //zoom: 1; - //width: 100%; - } - - - .panel .tree li .content - { - padding-left: 18px; - padding-top: 5px; - height: 18px; - overflow: hidden; - position: relative; - } - - .panel .tree li .icon - { - width: 10px; - height: 9px; - background: url(http://github.com/i/arrows.png); - background-position: 0 -9px; - position: absolute; - left: 1px; - top: 8px; - cursor: default; - } - - .panel .tree li.closed .icon - { - background-position: 0 0; - } - - .panel .tree ul li h1 - { - font-size: 13px; - font-weight: normal; - color: #000; - margin-bottom: 2px; - white-space: nowrap; - } - - .panel .tree ul li p - { - font-size: 11px; - color: #666; - margin-bottom: 2px; - white-space: nowrap; - } - - .panel .tree ul li h1 i - { - color: #999; - font-style: normal; - } - - .panel .tree ul li.empty - { - cursor: text; - } - - .panel .tree ul li.empty h1, - .panel .tree ul li.empty p - { - color: #666; - font-style: italic; - } - - .panel .tree ul li.current - { - background: #3875D7; - } - - .panel .tree ul li.current .icon - { - background-position: -10px -9px; - } - - .panel .tree ul li.current.closed .icon - { - background-position: -10px 0; - } - - .panel .tree ul li.current h1 - { - color: #FFF; - } - - .panel .tree ul li.current p - { - color: #CCC; - } - - .panel .tree ul li.current.empty h1, - .panel .tree ul li.current.empty p - { - color: #999; - } - - .panel .tree ul li:hover - { - background: #d0d0d0; - } - - .panel .tree ul li.current:hover - { - background: #2965C0; - } - - .panel .tree .stopper - { - display: none; - } - /* Tree (end) */ /**/ - -/* Panel (end) */ - - -.panel .loader -{ - text-align: center; - margin-top: 2px; - width: 100%; - height: 59px; -} - -.panel .loader img -{ - vertical-align: middle; -} diff --git a/docs/API/API/css/reset.css b/docs/API/API/css/reset.css deleted file mode 100644 index 13f8e0a14..000000000 --- a/docs/API/API/css/reset.css +++ /dev/null @@ -1,53 +0,0 @@ -/* http://meyerweb.com/eric/tools/css/reset/ */ -/* v1.0 | 20080212 */ - -html, body, div, span, applet, object, iframe, -h1, h2, h3, h4, h5, h6, p, blockquote, pre, -a, abbr, acronym, address, big, cite, code, -del, dfn, em, font, img, ins, kbd, q, s, samp, -small, strike, strong, sub, sup, tt, var, -b, u, i, center, -dl, dt, dd, ol, ul, li, -fieldset, form, label, legend, -table, caption, tbody, tfoot, thead, tr, th, td { - margin: 0; - padding: 0; - border: 0; - outline: 0; - font-size: 100%; - vertical-align: baseline; - background: transparent; -} -body { - line-height: 1; -} -ol, ul { - list-style: none; -} -blockquote, q { - quotes: none; -} -blockquote:before, blockquote:after, -q:before, q:after { - content: ''; - content: none; -} - -/* remember to define focus styles! */ -:focus { - outline: 0; -} - -/* remember to highlight inserts somehow! */ -ins { - text-decoration: none; -} -del { - text-decoration: line-through; -} - -/* tables still need 'cellspacing="0"' in the markup */ -table { - border-collapse: collapse; - border-spacing: 0; -} \ No newline at end of file diff --git a/docs/API/API/css/sami.css b/docs/API/API/css/sami.css new file mode 100644 index 000000000..4c089c34f --- /dev/null +++ b/docs/API/API/css/sami.css @@ -0,0 +1,459 @@ +html, body, #content { + height: 100%; +} + +/* Site menu */ + +#site-nav.navbar-default { + margin: 0; + border-radius: 0; + border-bottom: 1px solid #ccc; + background-color: #EDF3FE; + background-image: none; +} + +#site-nav.navbar-default .navbar-brand, +#site-nav.navbar-default .navbar-nav > li > a { + color: #000; +} + +#site-nav.navbar-default .navbar-nav > li > a:hover { + text-decoration: underline; +} + +#navbar-elements { + float: right; +} + +@media (max-width: 768px) { + #navbar-elements { + float: none !important; + } +} + +/* Namespace breadcrumbs */ + +.namespace-breadcrumbs .breadcrumb { + margin: 0 0 12px; + border-radius: 0 0 4px 4px; + padding-left: 35px; +} + +.namespace-breadcrumbs .breadcrumb > li + li:before { + content: ""; +} +.namespace-breadcrumbs .breadcrumb > .backslash { + color: #ccc; +} + +/* Site columns */ + +#right-column { + margin-left: 20%; +} + +#page-content { + padding: 0 30px; +} + +#left-column { + width: 20%; + position: fixed; + height: 100%; + border-right: 1px solid #ccc; + line-height: 18px; + font-size: 13px; + display: flex; + flex-flow: column; +} + +@media (max-width: 991px) { + #left-column { + display: none; + } + #right-column { + width: 100%; + margin-left: 0; + } +} + +/* API Tree */ + +#api-tree { + background: linear-gradient( + to bottom, + #FFF, + #FFF 50%, + #EDF3FE 50%, + #EDF3FE + ); + background-size: 100% 56px; + overflow: auto; + height: 100%; + background-attachment: local; +} + +#api-tree ul { + list-style-type: none; + margin: 0; + padding: 0; +} + +#api-tree ul li { + padding: 0; + margin: 0; +} + +/* Prevents the menu from jittering on lad */ +#api-tree .glyphicon-play { + width: 26px; +} + +#api-tree ul li .hd { + padding: 5px; +} + +#api-tree li .hd:nth-child(even) { + background-color: #EDF3FE; +} + +#api-tree ul li.opened > .hd span { + -webkit-transform: rotate(90deg); + -moz-transform: rotate(90deg); + -o-transform: rotate(90deg); + -ms-transform: rotate(90deg); + transform: rotate(90deg); +} + +#api-tree .bd { + display: none; +} + +#api-tree li.opened > .bd { + display: block; +} + +#api-tree li .hd:hover { + background-color: #eee; +} + +#api-tree li.active > .hd { + background-color: #3875D7; +} + +#api-tree li.active > .hd a { + color: #eee; + font-weight: bold; +} + +#api-tree a { + color: #222; +} + +#api-tree div.leaf a { + margin-left: 20px; +} + +#api-tree .hd span { + padding: 2px 8px; + font-size: 10px; + line-height: 85%; +} + +/* Control panel, search form, version drop-down */ + +#control-panel { + background: #e8e8e8; + border-bottom: 1px solid #666; + padding: 4px; +} + +#control-panel form { + margin: 4px 4px 5px 4px; +} + +#search-form { + position: relative; +} + +#search-form input { + width: 100%; + padding-left: 28px; +} + +#search-form span.glyphicon-search { + position: absolute; + left: 9px; + top: 9px; + font-size: 14px; + z-index: 2; +} + +/* Typeahead */ + +.twitter-typeahead { + width: 100%; + z-index: 1; +} + +.tt-dropdown-menu { + overflow: auto; + max-height: 260px; + margin-top: 9px; + background-color: #fff; + border: 1px solid #ccc; + border-radius: 8px; + box-shadow: 0 5px 10px rgba(0,0,0,.2); + padding: 8px; +} + +.tt-dropdown-menu p { + margin: 0; + padding: 0; +} + +.tt-suggestion { + padding: 8px; + border-bottom: 1px solid #ccc; + font-size: 1.1em; +} + +.tt-cursor { + background-color: #3875D7; + color: #fff; +} + +/** General typography **/ + +.navbar { + border-bottom: 0; +} + +.page-header { + margin: 0 0 20px; +} + +abbr[title], abbr[data-original-title], abbr { + border-bottom: none; + cursor: pointer; +} + +a abbr { + cursor: pointer; +} + +.method-description table, .description table { + border: solid 1px #ccc; + padding: 1em; + margin: 1em; +} + +.method-description td, .method-description th, +.description td, .description th { + padding: 0.75em 1.25em; +} + +.method-description tbody tr:nth-child(even), +.description tbody tr:nth-child(even) { + background: #edf3fe; +} + +.method-description tbody tr:nth-child(odd), +.description tbody tr:nth-child(odd) { + background: #fff; +} + +.method-description thead tr, +.description thead tr { + background: #edf3fe; +} + +/** General Sami styling **/ + +.underlined > .row { + padding: 8px 0; + border-bottom: 1px solid #ddd; +} + +#footer { + text-align: right; + margin: 30px; + font-size: 11px; +} + +.description { + margin: 10px 0; + padding: 10px; + background-color: #efefef; +} + +.description p { + padding: 0; + margin: 8px 0; +} + +.method-description { + margin: 0 0 24px 0; +} + +.details { + padding-left: 30px; +} + +#method-details .method-item { + margin-bottom: 30px; +} + +.method-item h3, +.method-item h3 code { + background-color: #eee; +} + +.method-item h3 { + padding: 4px; + margin-bottom: 20px; + font-size: 20px; +} + +.location { + font-size: 11px; + float: right; + font-style: italic; +} + +.namespace-list a { + padding: 3px 8px; + margin: 0 5px 5px 0; + border: 1px solid #ddd; + background-color: #f9f9f9; + display: inline-block; + border-radius: 4px; +} + +.no-description { + color: #ccc; + font-size: 90%; +} + +/* Namespaces page */ + +.namespaces { + clear: both; +} + +.namespaces .namespace-container { + float: left; + margin: 0 14px 14px 0; + min-width: 30%; +} + +.namespaces h2 { + margin: 0 0 20px 0; +} + +@media (max-width: 991px) { + .namespaces .namespace-container { + margin-right: 0; + width: 100%; + } +} + +/** Code and pre tags **/ + +tt, code, pre { + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; +} + +code { + padding: 0; + padding-top: 0.2em; + padding-bottom: 0.2em; + margin: 0; + font-size: 85%; + background-color: rgba(0,0,0,0.04); + border-radius: 3px; + color: #333; +} + +pre { + padding: 16px; + overflow: auto; + font-size: 85%; + line-height: 1.45; + background-color: #f7f7f7; + border-radius: 3px; +} + +h2 { + background-color: #EDF3FE; + padding: 4px 4px 4px 8px; + font-size: 25px; + margin: 20px 0; +} + +/** Doc index **/ + +dt { + font-weight: normal; +} + +dd { + margin-left: 30px; + line-height: 1.5em; +} + +#doc-index h2 { + font-weight: bold; + margin: 30px 0; +} + +#doc-index .pagination { + margin: 0; +} + +/* Search page */ + +.search-results { + list-style-type: none; + padding: 0; + margin: 0; +} + +.search-results li { + list-style-type: none; + margin: 0; + padding: 14px 0; + border-bottom: 1px solid #ccc; +} + +.search-results h2 { + background: none; + margin: 0; + padding: 0; + font-size: 18px; +} + +.search-results h2 a { + float: left; + display: block; + margin: 0 0 4px 0; +} + +.search-results .search-type { + float: right; + margin: 0 0 4px 0; +} + +.search-results .search-from { + margin: 0 0 12px 0; + font-size: 12px; + color: #999; +} + +.search-results .search-from a { + font-style: italic; +} + +.search-results .search-description { + margin: 8px 0 0 30px; +} diff --git a/docs/API/API/doc-index.html b/docs/API/API/doc-index.html index 433c6e5a3..d3d6417af 100644 --- a/docs/API/API/doc-index.html +++ b/docs/API/API/doc-index.html @@ -1,525 +1,706 @@ - - - - Index | - - - -
- + + + + Index | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -
Index
+ +
+
+
+ +
+ + +
+
+ +
+ +
+
+ + +
+ +
+

Index

+
- A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z -
-
-

A

+ + +

A

DrawerInterface::arc() — Method in class DrawerInterface
-
Draws an arc on a starting at a given x, y coordinates under a given start and end angles
Border::apply() — Method in class Border
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Canvas::apply() — Method in class Canvas
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
OnPixelBased::apply() — Method in class OnPixelBased
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
RelativeResize::apply() — Method in class RelativeResize
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
ApplyMask — Class in namespace Imagine\Filter\Basic
-
An apply mask filter
ApplyMask::apply() — Method in class ApplyMask
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Autorotate — Class in namespace Imagine\Filter\Basic
+
Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.
BlackWhite::apply() — Method in class BlackWhite
+
Applies scheduled transformation to an ImageInterface instance.
Border::apply() — Method in class Border
+
Applies scheduled transformation to an ImageInterface instance.
Canvas::apply() — Method in class Canvas
+
Applies scheduled transformation to an ImageInterface instance.
Negation::apply() — Method in class Negation
+
Applies scheduled transformation to an ImageInterface instance.
Neighborhood::apply() — Method in class Neighborhood
+
Applies scheduled transformation to an ImageInterface instance.
OnPixelBased::apply() — Method in class OnPixelBased
+
Applies scheduled transformation to an ImageInterface instance.
RelativeResize::apply() — Method in class RelativeResize
+
Applies scheduled transformation to an ImageInterface instance.
ApplyMask — Class in namespace Imagine\Filter\Basic
+
An apply mask filter.
ApplyMask::apply() — Method in class ApplyMask
+
Applies scheduled transformation to an ImageInterface instance.
Autorotate — Class in namespace Imagine\Filter\Basic
Rotates an image automatically based on exif information.
Autorotate::apply() — Method in class Autorotate
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Copy::apply() — Method in class Copy
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Crop::apply() — Method in class Crop
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Fill::apply() — Method in class Fill
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
FlipHorizontally::apply() — Method in class FlipHorizontally
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
FlipVertically::apply() — Method in class FlipVertically
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Paste::apply() — Method in class Paste
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Resize::apply() — Method in class Resize
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Rotate::apply() — Method in class Rotate
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Save::apply() — Method in class Save
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Show::apply() — Method in class Show
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Strip::apply() — Method in class Strip
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Thumbnail::apply() — Method in class Thumbnail
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
WebOptimization::apply() — Method in class WebOptimization
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
FilterInterface::apply() — Method in class FilterInterface
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Transformation::applyFilter() — Method in class Transformation
-
Applies a given FilterInterface onto given ImageInterface and returns modified ImageInterface
Transformation::apply() — Method in class Transformation
-
Applies scheduled transformation to ImageInterface instance Returns processed ImageInterface instance
Transformation::applyMask() — Method in class Transformation
-
Applies a given mask to current image's alpha channel
Transformation::add() — Method in class Transformation
-
Registers a given FilterInterface in an internal array of filters for later application to an instance of ImageInterface
Drawer::arc() — Method in class Drawer
-
Draws an arc on a starting at a given x, y coordinates under a given start and end angles
Image::applyMask() — Method in class Image
-
Applies a given mask to current image's alpha channel
Layers::animate() — Method in class Layers
-
Animates layers
Drawer::arc() — Method in class Drawer
-
Draws an arc on a starting at a given x, y coordinates under a given start and end angles
Image::applyMask() — Method in class Image
-
Applies a given mask to current image's alpha channel
Layers::animate() — Method in class Layers
-
Animates layers
AbstractFont — Class in namespace Imagine\Image
-
Abstract font base class
AbstractImage — Class in namespace Imagine\Image
-
-
AbstractImagine — Class in namespace Imagine\Image
-
-
AbstractLayers — Class in namespace Imagine\Image
-
-
AbstractLayers::add() — Method in class AbstractLayers
-
Adds an image at the end of the layers stack
Bucket::add() — Method in class Bucket
-
-
LayersInterface::animate() — Method in class LayersInterface
-
Animates layers
LayersInterface::add() — Method in class LayersInterface
-
Adds an image at the end of the layers stack
ManipulatorInterface::applyMask() — Method in class ManipulatorInterface
-
Applies a given mask to current image's alpha channel
AbstractMetadataReader — Class in namespace Imagine\Image\Metadata
-
-
Drawer::arc() — Method in class Drawer
-
Draws an arc on a starting at a given x, y coordinates under a given start and end angles
Image::applyMask() — Method in class Image
-
Applies a given mask to current image's alpha channel
Layers::animate() — Method in class Layers
-
Animates layers
ImagineTestCase::assertImageEquals() — Method in class ImagineTestCase
-
Asserts that two images are equal using color histogram comparison method

B

+
Applies scheduled transformation to an ImageInterface instance.
Copy::apply() — Method in class Copy
+
Applies scheduled transformation to an ImageInterface instance.
Crop::apply() — Method in class Crop
+
Applies scheduled transformation to an ImageInterface instance.
Fill::apply() — Method in class Fill
+
Applies scheduled transformation to an ImageInterface instance.
FlipHorizontally::apply() — Method in class FlipHorizontally
+
Applies scheduled transformation to an ImageInterface instance.
FlipVertically::apply() — Method in class FlipVertically
+
Applies scheduled transformation to an ImageInterface instance.
Paste::apply() — Method in class Paste
+
Applies scheduled transformation to an ImageInterface instance.
Resize::apply() — Method in class Resize
+
Applies scheduled transformation to an ImageInterface instance.
Rotate::apply() — Method in class Rotate
+
Applies scheduled transformation to an ImageInterface instance.
Save::apply() — Method in class Save
+
Applies scheduled transformation to an ImageInterface instance.
Show::apply() — Method in class Show
+
Applies scheduled transformation to an ImageInterface instance.
Strip::apply() — Method in class Strip
+
Applies scheduled transformation to an ImageInterface instance.
Thumbnail::apply() — Method in class Thumbnail
+
Applies scheduled transformation to an ImageInterface instance.
WebOptimization::apply() — Method in class WebOptimization
+
Applies scheduled transformation to an ImageInterface instance.
FilterInterface::apply() — Method in class FilterInterface
+
Applies scheduled transformation to an ImageInterface instance.
Transformation::applyFilter() — Method in class Transformation
+
Applies a given FilterInterface onto given ImageInterface and returns modified ImageInterface.
Transformation::apply() — Method in class Transformation
+
Applies scheduled transformation to an ImageInterface instance.
Transformation::applyMask() — Method in class Transformation
+
Applies a given mask to current image's alpha channel.
Transformation::add() — Method in class Transformation
+
Registers a given FilterInterface in an internal array of filters for later application to an instance of ImageInterface.
Drawer::arc() — Method in class Drawer
+
Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.
Image::applyMask() — Method in class Image
+
Applies a given mask to current image's alpha channel.
Layers::animate() — Method in class Layers
+
Animates layers.
Drawer::arc() — Method in class Drawer
+
Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.
Image::applyMask() — Method in class Image
+
Applies a given mask to current image's alpha channel.
Layers::animate() — Method in class Layers
+
Animates layers.
AbstractFont — Class in namespace Imagine\Image
+
Abstract font base class.
AbstractImage — Class in namespace Imagine\Image
+
AbstractImagine — Class in namespace Imagine\Image
+
AbstractLayers — Class in namespace Imagine\Image
+
AbstractLayers::add() — Method in class AbstractLayers
+
Adds an image at the end of the layers stack.
Bucket::add() — Method in class Bucket
+
LayersInterface::animate() — Method in class LayersInterface
+
Animates layers.
LayersInterface::add() — Method in class LayersInterface
+
Adds an image at the end of the layers stack.
ManipulatorInterface::applyMask() — Method in class ManipulatorInterface
+
Applies a given mask to current image's alpha channel.
AbstractMetadataReader — Class in namespace Imagine\Image\Metadata
+
Base class for the default metadata readers.
Drawer::arc() — Method in class Drawer
+
Draws an arc on a starting at a given x, y coordinates under a given +start and end angles.
Image::applyMask() — Method in class Image
+
Applies a given mask to current image's alpha channel.
Layers::animate() — Method in class Layers
+
Animates layers.

B

EffectsInterface::blur() — Method in class EffectsInterface
-
Blur the image
Border — Class in namespace Imagine\Filter\Advanced
-
A border filter
Effects::blur() — Method in class Effects
-
Blur the image
Font::box() — Method in class Font
-
Gets BoxInterface of font size on the image based on string and angle
Effects::blur() — Method in class Effects
-
Blur the image
Font::box() — Method in class Font
-
Gets BoxInterface of font size on the image based on string and angle
Box — Class in namespace Imagine\Image
-
A box implementation
BoxInterface — Class in namespace Imagine\Image
-
Interface for a box
FontInterface::box() — Method in class FontInterface
-
Gets BoxInterface of font size on the image based on string and angle
Bucket — Class in namespace Imagine\Image\Histogram
-
Bucket histogram
CMYK::blend() — Method in class CMYK
-
Blend two colors given an amount
Grayscale::blend() — Method in class Grayscale
-
Blend two colors given an amount
PaletteInterface::blend() — Method in class PaletteInterface
-
Blend two colors given an amount
RGB::blend() — Method in class RGB
-
Blend two colors given an amount
Effects::blur() — Method in class Effects
-
Blur the image
Font::box() — Method in class Font
-
Gets BoxInterface of font size on the image based on string and angle

C

+
Blur the image.
EffectsInterface::brightness() — Method in class EffectsInterface
+
Changes the brightness of the image.
BlackWhite — Class in namespace Imagine\Filter\Advanced
+
This filter calculates, for each pixel of an image, whether it is ligher or darker than a threshold.
Border — Class in namespace Imagine\Filter\Advanced
+
A border filter.
BorderDetection — Class in namespace Imagine\Filter\Advanced
+
BorderDetection based on Laplace-Operator. Three different variants are offered:.
Effects::blur() — Method in class Effects
+
Blur the image.
Effects::brightness() — Method in class Effects
+
Changes the brightness of the image.
Font::box() — Method in class Font
+
Gets BoxInterface of font size on the image based on string and angle.
Effects::blur() — Method in class Effects
+
Blur the image.
Effects::brightness() — Method in class Effects
+
Changes the brightness of the image.
Font::box() — Method in class Font
+
Gets BoxInterface of font size on the image based on string and angle.
Box — Class in namespace Imagine\Image
+
A box implementation.
BoxInterface — Class in namespace Imagine\Image
+
Interface for a box.
FontInterface::box() — Method in class FontInterface
+
Gets BoxInterface of font size on the image based on string and angle.
Bucket — Class in namespace Imagine\Image\Histogram
+
Bucket histogram.
CMYK::blend() — Method in class CMYK
+
Blend two colors given an amount.
Grayscale::blend() — Method in class Grayscale
+
Blend two colors given an amount.
PaletteInterface::blend() — Method in class PaletteInterface
+
Blend two colors given an amount.
RGB::blend() — Method in class RGB
+
Blend two colors given an amount.
Effects::blur() — Method in class Effects
+
Blur the image.
Effects::brightness() — Method in class Effects
+
Changes the brightness of the image.
Font::box() — Method in class Font
+
Gets BoxInterface of font size on the image based on string and angle.

C

DrawerInterface::chord() — Method in class DrawerInterface
-
Same as arc, but also connects end points with a straight line
EffectsInterface::colorize() — Method in class EffectsInterface
-
Colorize the image
Canvas — Class in namespace Imagine\Filter\Advanced
-
A canvas filter
Copy — Class in namespace Imagine\Filter\Basic
-
A copy filter
Crop — Class in namespace Imagine\Filter\Basic
-
A crop filter
Transformation::copy() — Method in class Transformation
-
Copies current source image into a new ImageInterface instance
Transformation::crop() — Method in class Transformation
-
Crops a specified box out of the source image (modifies the source image) Returns cropped self
Drawer::chord() — Method in class Drawer
-
This function does not work properly because of a bug in GD
Effects::colorize() — Method in class Effects
-
Colorize the image
Image::copy() — Method in class Image
-
Copies current source image into a new ImageInterface instance
Image::crop() — Method in class Image
-
Crops a specified box out of the source image (modifies the source image) Returns cropped self
Imagine::create() — Method in class Imagine
-
Creates a new empty image with an optional background color
Layers::coalesce() — Method in class Layers
-
Coalesce layers.
Layers::current() — Method in class Layers
+
Same as arc, but also connects end points with a straight line.
DrawerInterface::circle() — Method in class DrawerInterface
+
Draws and circle with center at the given x, y coordinates, and given radius.
EffectsInterface::colorize() — Method in class EffectsInterface
+
Colorize the image.
EffectsInterface::convolve() — Method in class EffectsInterface
+
Convolves the image.
ClassFactory — Class in namespace Imagine\Factory
+
The default implementation of Imagine\Factory\ClassFactoryInterface.
ClassFactory::createMetadataReader() — Method in class ClassFactory
+
Create a new instance of a metadata reader.
ClassFactory::createBox() — Method in class ClassFactory
+
Create new BoxInterface instance.
ClassFactory::createFileLoader() — Method in class ClassFactory
+
Create a new instance of a file loader.
ClassFactory::createDrawer() — Method in class ClassFactory
+
Create a new DrawerInterface instance.
ClassFactory::createLayers() — Method in class ClassFactory
+
Crate a new instance of a layers interface.
ClassFactory::createEffects() — Method in class ClassFactory
+
Create a new EffectsInterface instance.
ClassFactory::createImage() — Method in class ClassFactory
+
Create a new ImageInterface instance.
ClassFactory::createFont() — Method in class ClassFactory
+
Create new FontInterface instance.
ClassFactoryAwareInterface — Class in namespace Imagine\Factory
+
An interface that classes that accepts a class factory should implement.
ClassFactoryInterface — Class in namespace Imagine\Factory
+
The interface that class factories must implement.
ClassFactoryInterface::createMetadataReader() — Method in class ClassFactoryInterface
+
Create a new instance of a metadata reader.
ClassFactoryInterface::createBox() — Method in class ClassFactoryInterface
+
Create new BoxInterface instance.
ClassFactoryInterface::createFont() — Method in class ClassFactoryInterface
+
Create new FontInterface instance.
ClassFactoryInterface::createFileLoader() — Method in class ClassFactoryInterface
+
Create a new instance of a file loader.
ClassFactoryInterface::createLayers() — Method in class ClassFactoryInterface
+
Crate a new instance of a layers interface.
ClassFactoryInterface::createImage() — Method in class ClassFactoryInterface
+
Create a new ImageInterface instance.
ClassFactoryInterface::createDrawer() — Method in class ClassFactoryInterface
+
Create a new DrawerInterface instance.
ClassFactoryInterface::createEffects() — Method in class ClassFactoryInterface
+
Create a new EffectsInterface instance.
Loader::checkLocalFile() — Method in class Loader
+
Check that the file exists and it's readable.
Canvas — Class in namespace Imagine\Filter\Advanced
+
A canvas filter.
$OnPixelBased#callback — Property in class OnPixelBased
+
Copy — Class in namespace Imagine\Filter\Basic
+
A copy filter.
Crop — Class in namespace Imagine\Filter\Basic
+
A crop filter.
Transformation::copy() — Method in class Transformation
+
Copies current source image into a new ImageInterface instance.
Transformation::crop() — Method in class Transformation
+
Crops a specified box out of the source image (modifies the source image) +Returns cropped self.
Drawer::chord() — Method in class Drawer
+
This function does not work properly because of a bug in GD.
Drawer::circle() — Method in class Drawer
+
Draws and circle with center at the given x, y coordinates, and given radius.
Effects::colorize() — Method in class Effects
+
Colorize the image.
Effects::convolve() — Method in class Effects
+
Convolves the image.
Image::copy() — Method in class Image
+
Copies current source image into a new ImageInterface instance.
Image::crop() — Method in class Image
+
Crops a specified box out of the source image (modifies the source image) +Returns cropped self.
Imagine::create() — Method in class Imagine
+
Creates a new empty image with an optional background color.
Layers::coalesce() — Method in class Layers
+
Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.
Layers::current() — Method in class Layers
{@inheritdoc}
Layers::count() — Method in class Layers
{@inheritdoc}
Drawer::chord() — Method in class Drawer
-
Same as arc, but also connects end points with a straight line
Effects::colorize() — Method in class Effects
-
Colorize the image
Image::copy() — Method in class Image
-
Copies current source image into a new ImageInterface instance
Image::crop() — Method in class Image
-
Crops a specified box out of the source image (modifies the source image) Returns cropped self
Imagine::create() — Method in class Imagine
-
Creates a new empty image with an optional background color
Layers::coalesce() — Method in class Layers
-
Coalesce layers.
Layers::current() — Method in class Layers
+
Same as arc, but also connects end points with a straight line.
Drawer::circle() — Method in class Drawer
+
Draws and circle with center at the given x, y coordinates, and given radius.
Effects::colorize() — Method in class Effects
+
Colorize the image.
Effects::convolve() — Method in class Effects
+
Convolves the image.
Image::copy() — Method in class Image
+
Copies current source image into a new ImageInterface instance.
Image::crop() — Method in class Image
+
Crops a specified box out of the source image (modifies the source image) +Returns cropped self.
Imagine::create() — Method in class Imagine
+
Creates a new empty image with an optional background color.
Layers::coalesce() — Method in class Layers
+
Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.
Layers::current() — Method in class Layers
{@inheritdoc}
Layers::count() — Method in class Layers
-
{@inheritdoc}
Box::contains() — Method in class Box
-
Checks whether current box can fit given box at a given start position, start position defaults to top left corner xy(0,0)
BoxInterface::contains() — Method in class BoxInterface
-
Checks whether current box can fit given box at a given start position, start position defaults to top left corner xy(0,0)
Bucket::count() — Method in class Bucket
-
-
Range::contains() — Method in class Range
-
-
ImagineInterface::create() — Method in class ImagineInterface
-
Creates a new empty image with an optional background color
LayersInterface::coalesce() — Method in class LayersInterface
-
Coalesce layers.
ManipulatorInterface::copy() — Method in class ManipulatorInterface
-
Copies current source image into a new ImageInterface instance
ManipulatorInterface::crop() — Method in class ManipulatorInterface
-
Crops a specified box out of the source image (modifies the source image) Returns cropped self
CMYK — Class in namespace Imagine\Image\Palette
-
-
CMYK::color() — Method in class CMYK
-
Returns a color given some values
ColorParser — Class in namespace Imagine\Image\Palette
-
-
CMYK — Class in namespace Imagine\Image\Palette\Color
-
-
ColorInterface — Class in namespace Imagine\Image\Palette\Color
-
-
Grayscale::color() — Method in class Grayscale
-
Returns a color given some values
PaletteInterface::color() — Method in class PaletteInterface
-
Returns a color given some values
RGB::color() — Method in class RGB
-
Returns a color given some values
Center — Class in namespace Imagine\Image\Point
-
Point center
Drawer::chord() — Method in class Drawer
-
Same as arc, but also connects end points with a straight line
Effects::colorize() — Method in class Effects
-
Colorize the image
Image::copy() — Method in class Image
-
Copies current source image into a new ImageInterface instance
Image::crop() — Method in class Image
-
Crops a specified box out of the source image (modifies the source image) Returns cropped self
Imagine::create() — Method in class Imagine
-
Creates a new empty image with an optional background color
Layers::coalesce() — Method in class Layers
-
Coalesce layers.
Layers::current() — Method in class Layers
+
{@inheritdoc}
$AbstractFont#color — Property in class AbstractFont
+
AbstractImagine::checkPath() — Method in class AbstractImagine
+
Checks a path that could be used with ImagineInterface::open and returns +a proper string.
Box::contains() — Method in class Box
+
Checks whether current box can fit given box at a given start position, +start position defaults to top left corner xy(0,0).
BoxInterface::contains() — Method in class BoxInterface
+
Checks whether current box can fit given box at a given start position, +start position defaults to top left corner xy(0,0).
Bucket::count() — Method in class Bucket
+
Range::contains() — Method in class Range
+
ImagineInterface::create() — Method in class ImagineInterface
+
Creates a new empty image with an optional background color.
LayersInterface::coalesce() — Method in class LayersInterface
+
Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.
ManipulatorInterface::copy() — Method in class ManipulatorInterface
+
Copies current source image into a new ImageInterface instance.
ManipulatorInterface::crop() — Method in class ManipulatorInterface
+
Crops a specified box out of the source image (modifies the source image) +Returns cropped self.
MetadataBag::count() — Method in class MetadataBag
+
{@inheritdoc}
CMYK — Class in namespace Imagine\Image\Palette
+
The CMYK palette.
CMYK::color() — Method in class CMYK
+
Returns a color given some values.
ColorParser — Class in namespace Imagine\Image\Palette
+
CMYK — Class in namespace Imagine\Image\Palette\Color
+
ColorInterface — Class in namespace Imagine\Image\Palette\Color
+
$Grayscale#colors — Property in class Grayscale
+
Grayscale::color() — Method in class Grayscale
+
Returns a color given some values.
PaletteInterface::color() — Method in class PaletteInterface
+
Returns a color given some values.
$RGB#colors — Property in class RGB
+
RGB::color() — Method in class RGB
+
Returns a color given some values.
Center — Class in namespace Imagine\Image\Point
+
Center point of a box.
Drawer::chord() — Method in class Drawer
+
Same as arc, but also connects end points with a straight line.
Drawer::circle() — Method in class Drawer
+
Draws and circle with center at the given x, y coordinates, and given radius.
Effects::colorize() — Method in class Effects
+
Colorize the image.
Effects::convolve() — Method in class Effects
+
Convolves the image.
Image::copy() — Method in class Image
+
Copies current source image into a new ImageInterface instance.
Image::crop() — Method in class Image
+
Crops a specified box out of the source image (modifies the source image) +Returns cropped self.
Image::cloneImagick() — Method in class Image
+
Clone the Imagick resource of this instance.
Imagine::create() — Method in class Imagine
+
Creates a new empty image with an optional background color.
Layers::coalesce() — Method in class Layers
+
Coalesce layers. Each layer in the sequence is the same size as the first and composited with the next layer in +the sequence.
Layers::current() — Method in class Layers
{@inheritdoc}
Layers::count() — Method in class Layers
-
{@inheritdoc}

D

+
{@inheritdoc}
Matrix::calculatePosition() — Method in class Matrix
+
Calculate the offset position of a cell.

D

DrawerInterface — Class in namespace Imagine\Draw
-
Interface for the drawer
DrawerInterface::dot() — Method in class DrawerInterface
-
Places a one pixel point at specific coordinates and fills it with specified color
Drawer — Class in namespace Imagine\Gd
-
Drawer implementation using the GD library
Drawer::dot() — Method in class Drawer
-
Places a one pixel point at specific coordinates and fills it with specified color
Image::draw() — Method in class Image
-
Instantiates and returns a DrawerInterface instance for image drawing
Drawer — Class in namespace Imagine\Gmagick
-
Drawer implementation using the Gmagick PHP extension
Drawer::dot() — Method in class Drawer
-
Places a one pixel point at specific coordinates and fills it with specified color
Image::draw() — Method in class Image
-
Instantiates and returns a DrawerInterface instance for image drawing
ImageInterface::draw() — Method in class ImageInterface
-
Instantiates and returns a DrawerInterface instance for image drawing
DefaultMetadataReader — Class in namespace Imagine\Image\Metadata
-
Default metadata reader
CMYK::dissolve() — Method in class CMYK
-
Returns a copy of current color, incrementing the alpha channel by the given amount
CMYK::darken() — Method in class CMYK
-
Returns a copy of the current color, darkened by the specified number of shades
ColorInterface::dissolve() — Method in class ColorInterface
-
Returns a copy of current color, incrementing the alpha channel by the given amount
ColorInterface::darken() — Method in class ColorInterface
-
Returns a copy of the current color, darkened by the specified number of shades
Gray::dissolve() — Method in class Gray
-
Returns a copy of current color, incrementing the alpha channel by the given amount
Gray::darken() — Method in class Gray
-
Returns a copy of the current color, darkened by the specified number of shades
RGB::dissolve() — Method in class RGB
-
Returns a copy of current color, incrementing the alpha channel by the given amount
RGB::darken() — Method in class RGB
-
Returns a copy of the current color, darkened by the specified number of shades
Profile::data() — Method in class Profile
-
Returns the profile data
ProfileInterface::data() — Method in class ProfileInterface
-
Returns the profile data
Drawer — Class in namespace Imagine\Imagick
-
Drawer implementation using the Imagick PHP extension
Drawer::dot() — Method in class Drawer
-
Places a one pixel point at specific coordinates and fills it with specified color
Image::draw() — Method in class Image
-
Instantiates and returns a DrawerInterface instance for image drawing

E

+
Interface for the drawer.
DrawerInterface::dot() — Method in class DrawerInterface
+
Places a one pixel point at specific coordinates and fills it with +specified color.
$Loader#data — Property in class Loader
+
The loaded data.
Drawer — Class in namespace Imagine\Gd
+
Drawer implementation using the GD PHP extension.
Drawer::dot() — Method in class Drawer
+
Places a one pixel point at specific coordinates and fills it with +specified color.
Image::draw() — Method in class Image
+
Instantiates and returns a DrawerInterface instance for image drawing.
Drawer — Class in namespace Imagine\Gmagick
+
Drawer implementation using the Gmagick PHP extension.
Drawer::dot() — Method in class Drawer
+
Places a one pixel point at specific coordinates and fills it with +specified color.
Image::draw() — Method in class Image
+
Instantiates and returns a DrawerInterface instance for image drawing.
ImageInterface::draw() — Method in class ImageInterface
+
Instantiates and returns a DrawerInterface instance for image drawing.
DefaultMetadataReader — Class in namespace Imagine\Image\Metadata
+
A metadata reader that actually doesn't try to extract metadata.
CMYK::dissolve() — Method in class CMYK
+
Returns a copy of current color, incrementing the alpha channel by the given amount.
CMYK::darken() — Method in class CMYK
+
Returns a copy of the current color, darkened by the specified number of shades.
ColorInterface::dissolve() — Method in class ColorInterface
+
Returns a copy of current color, incrementing the alpha channel by the given amount.
ColorInterface::darken() — Method in class ColorInterface
+
Returns a copy of the current color, darkened by the specified number of shades.
Gray::dissolve() — Method in class Gray
+
Returns a copy of current color, incrementing the alpha channel by the given amount.
Gray::darken() — Method in class Gray
+
Returns a copy of the current color, darkened by the specified number of shades.
RGB::dissolve() — Method in class RGB
+
Returns a copy of current color, incrementing the alpha channel by the given amount.
RGB::darken() — Method in class RGB
+
Returns a copy of the current color, darkened by the specified number of shades.
Profile::data() — Method in class Profile
+
Returns the profile data.
ProfileInterface::data() — Method in class ProfileInterface
+
Returns the profile data.
Drawer — Class in namespace Imagine\Imagick
+
Drawer implementation using the Imagick PHP extension.
Drawer::dot() — Method in class Drawer
+
Places a one pixel point at specific coordinates and fills it with +specified color.
Image::draw() — Method in class Image
+
Instantiates and returns a DrawerInterface instance for image drawing.

E

DrawerInterface::ellipse() — Method in class DrawerInterface
-
Draws and ellipse with center at the given x, y coordinates, and given width and height
EffectsInterface — Class in namespace Imagine\Effects
-
Interface for the effects
Exception — Class in namespace Imagine\Exception
-
Imagine-specific exception
Drawer::ellipse() — Method in class Drawer
-
Draws and ellipse with center at the given x, y coordinates, and given width and height
Effects — Class in namespace Imagine\Gd
-
Effects implementation using the GD library
Image::effects() — Method in class Image
-
-
Drawer::ellipse() — Method in class Drawer
-
Draws and ellipse with center at the given x, y coordinates, and given width and height
Effects — Class in namespace Imagine\Gmagick
-
Effects implementation using the Gmagick PHP extension
Image::effects() — Method in class Image
-
-
ImageInterface::effects() — Method in class ImageInterface
-
-
ExifMetadataReader — Class in namespace Imagine\Image\Metadata
-
Metadata driven by Exif information
Drawer::ellipse() — Method in class Drawer
-
Draws and ellipse with center at the given x, y coordinates, and given width and height
Effects — Class in namespace Imagine\Imagick
-
Effects implementation using the Imagick PHP extension
Image::effects() — Method in class Image
-
-
IsImageEqual::evaluate() — Method in class IsImageEqual
-
{@inheritdoc}

F

-
Fill — Class in namespace Imagine\Filter\Basic
-
A fill filter
FlipHorizontally — Class in namespace Imagine\Filter\Basic
-
A "flip horizontally" filter
FlipVertically — Class in namespace Imagine\Filter\Basic
-
A "flip vertically" filter
FilterInterface — Class in namespace Imagine\Filter
-
Interface for imagine filters
Transformation::flipHorizontally() — Method in class Transformation
-
Flips current image using horizontal axis
Transformation::flipVertically() — Method in class Transformation
-
Flips current image using vertical axis
Transformation::fill() — Method in class Transformation
-
Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image
Font — Class in namespace Imagine\Gd
-
Font implementation using the GD library
Image::flipHorizontally() — Method in class Image
-
Flips current image using horizontal axis
Image::flipVertically() — Method in class Image
-
Flips current image using vertical axis
Image::fill() — Method in class Image
-
Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image
Imagine::font() — Method in class Imagine
-
Constructs a font with specified $file, $size and $color
Font — Class in namespace Imagine\Gmagick
-
Font implementation using the Gmagick PHP extension
Image::flipHorizontally() — Method in class Image
-
Flips current image using horizontal axis
Image::flipVertically() — Method in class Image
-
Flips current image using vertical axis
Image::fill() — Method in class Image
-
Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image
Imagine::font() — Method in class Imagine
-
Constructs a font with specified $file, $size and $color
FillInterface — Class in namespace Imagine\Image\Fill
-
Interface for the fill
FontInterface — Class in namespace Imagine\Image
-
The font interface
ImagineInterface::font() — Method in class ImagineInterface
-
Constructs a font with specified $file, $size and $color
ManipulatorInterface::flipHorizontally() — Method in class ManipulatorInterface
-
Flips current image using horizontal axis
ManipulatorInterface::flipVertically() — Method in class ManipulatorInterface
-
Flips current image using vertical axis
ManipulatorInterface::fill() — Method in class ManipulatorInterface
-
Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image
Profile::fromPath() — Method in class Profile
-
Creates a profile from a path to a file
Font — Class in namespace Imagine\Imagick
-
Font implementation using the Imagick PHP extension
Image::flipHorizontally() — Method in class Image
-
Flips current image using horizontal axis
Image::flipVertically() — Method in class Image
-
Flips current image using vertical axis
Image::fill() — Method in class Image
-
Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image
Imagine::font() — Method in class Imagine
-
Constructs a font with specified $file, $size and $color

G

+
Draws and ellipse with center at the given x, y coordinates, and given width and height.
EffectsInterface — Class in namespace Imagine\Effects
+
Interface for the effects.
Exception — Class in namespace Imagine\Exception
+
Imagine-specific exception.
Drawer::ellipse() — Method in class Drawer
+
Draws and ellipse with center at the given x, y coordinates, and given width and height.
Effects — Class in namespace Imagine\Gd
+
Effects implementation using the GD PHP extension.
Image::effects() — Method in class Image
+
Drawer::ellipse() — Method in class Drawer
+
Draws and ellipse with center at the given x, y coordinates, and given width and height.
Effects — Class in namespace Imagine\Gmagick
+
Effects implementation using the Gmagick PHP extension.
Image::effects() — Method in class Image
+
ImageInterface::effects() — Method in class ImageInterface
+
AbstractMetadataReader::extractFromFile() — Method in class AbstractMetadataReader
+
Extracts metadata from a file.
AbstractMetadataReader::extractFromData() — Method in class AbstractMetadataReader
+
Extracts metadata from raw data.
AbstractMetadataReader::extractFromStream() — Method in class AbstractMetadataReader
+
Extracts metadata from a stream.
DefaultMetadataReader::extractFromFile() — Method in class DefaultMetadataReader
+
Extracts metadata from a file.
DefaultMetadataReader::extractFromData() — Method in class DefaultMetadataReader
+
Extracts metadata from raw data.
DefaultMetadataReader::extractFromStream() — Method in class DefaultMetadataReader
+
Extracts metadata from a stream.
ExifMetadataReader — Class in namespace Imagine\Image\Metadata
+
Metadata driven by Exif information.
ExifMetadataReader::extractFromFile() — Method in class ExifMetadataReader
+
Extracts metadata from a file.
ExifMetadataReader::extractFromData() — Method in class ExifMetadataReader
+
Extracts metadata from raw data.
ExifMetadataReader::extractFromStream() — Method in class ExifMetadataReader
+
Extracts metadata from a stream.
Drawer::ellipse() — Method in class Drawer
+
Draws and ellipse with center at the given x, y coordinates, and given width and height.
Effects — Class in namespace Imagine\Imagick
+
Effects implementation using the Imagick PHP extension.
Image::effects() — Method in class Image
+
ErrorHandling — Class in namespace Imagine\Utils
+
$Matrix#elements — Property in class Matrix
+
The array of elements.

F

+
ClassFactory::finalize() — Method in class ClassFactory
+
Finalize the newly created object.
Fill — Class in namespace Imagine\Filter\Basic
+
A fill filter.
FlipHorizontally — Class in namespace Imagine\Filter\Basic
+
A "flip horizontally" filter.
FlipVertically — Class in namespace Imagine\Filter\Basic
+
A "flip vertically" filter.
FilterInterface — Class in namespace Imagine\Filter
+
Interface for imagine filters.
Transformation::flipHorizontally() — Method in class Transformation
+
Flips current image using vertical axis.
Transformation::flipVertically() — Method in class Transformation
+
Flips current image using horizontal axis.
Transformation::fill() — Method in class Transformation
+
Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.
Font — Class in namespace Imagine\Gd
+
Font implementation using the GD library.
Image::flipHorizontally() — Method in class Image
+
Flips current image using vertical axis.
Image::flipVertically() — Method in class Image
+
Flips current image using horizontal axis.
Image::fill() — Method in class Image
+
Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.
Imagine::font() — Method in class Imagine
+
Constructs a font with specified $file, $size and $color.
Font — Class in namespace Imagine\Gmagick
+
Font implementation using the Gmagick PHP extension.
Image::flipHorizontally() — Method in class Image
+
Flips current image using vertical axis.
Image::flipVertically() — Method in class Image
+
Flips current image using horizontal axis.
Image::fill() — Method in class Image
+
Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.
Imagine::font() — Method in class Imagine
+
Constructs a font with specified $file, $size and $color.
$AbstractFont#file — Property in class AbstractFont
+
FillInterface — Class in namespace Imagine\Image\Fill
+
Interface for the fill.
FontInterface — Class in namespace Imagine\Image
+
The font interface.
ImagineInterface::font() — Method in class ImagineInterface
+
Constructs a font with specified $file, $size and $color.
ManipulatorInterface::flipHorizontally() — Method in class ManipulatorInterface
+
Flips current image using vertical axis.
ManipulatorInterface::flipVertically() — Method in class ManipulatorInterface
+
Flips current image using horizontal axis.
ManipulatorInterface::fill() — Method in class ManipulatorInterface
+
Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.
Profile::fromPath() — Method in class Profile
+
Creates a profile from a path to a file.
Font — Class in namespace Imagine\Imagick
+
Font implementation using the Imagick PHP extension.
Image::flipHorizontally() — Method in class Image
+
Flips current image using vertical axis.
Image::flipVertically() — Method in class Image
+
Flips current image using horizontal axis.
Image::fill() — Method in class Image
+
Fills image with provided filling, by replacing each pixel's color in +the current image with corresponding color from FillInterface, and +returns modified image.
Imagine::font() — Method in class Imagine
+
Constructs a font with specified $file, $size and $color.

G

EffectsInterface::gamma() — Method in class EffectsInterface
-
Apply gamma correction
EffectsInterface::grayscale() — Method in class EffectsInterface
-
Grayscale the image
Grayscale — Class in namespace Imagine\Filter\Advanced
-
The Grayscale filter calculates the gray-value based on RGB.
ImagineAware::getImagine() — Method in class ImagineAware
+
Apply gamma correction.
EffectsInterface::grayscale() — Method in class EffectsInterface
+
Grayscale the image.
ClassFactory::getGDInfo() — Method in class ClassFactory
+
ClassFactoryAwareInterface::getClassFactory() — Method in class ClassFactoryAwareInterface
+
Get the class factory instance to be used.
Loader::getPath() — Method in class Loader
+
Get the path of the file (local or remote).
Loader::getData() — Method in class Loader
+
Get the file binary contents.
LoaderInterface::getPath() — Method in class LoaderInterface
+
Get the path of the file (local or remote).
LoaderInterface::getData() — Method in class LoaderInterface
+
Get the file binary contents.
$BlackWhite#grayScaleFilter — Property in class BlackWhite
+
Grayscale — Class in namespace Imagine\Filter\Advanced
+
The Grayscale filter calculates the gray-value based on RGB.
Autorotate::getTransformations() — Method in class Autorotate
+
Get the transformations.
ImagineAware::getImagine() — Method in class ImagineAware
Get ImagineInterface instance.
Transformation::getFilters() — Method in class Transformation
-
Returns a list of filters sorted by their priority.
Effects::gamma() — Method in class Effects
-
Apply gamma correction
Effects::grayscale() — Method in class Effects
-
Grayscale the image
Image::getGdResource() — Method in class Image
-
Returns Gd resource
Image::get() — Method in class Image
-
Returns the image content as a binary string
Image::getSize() — Method in class Image
-
Returns current image size
Image::getColorAt() — Method in class Image
-
Returns color at specified positions of current image
Effects::gamma() — Method in class Effects
-
Apply gamma correction
Effects::grayscale() — Method in class Effects
-
Grayscale the image
Image::getGmagick() — Method in class Image
-
Returns gmagick instance
Image::get() — Method in class Image
-
Returns the image content as a binary string
Image::getSize() — Method in class Image
-
Returns current image size
Image::getColorAt() — Method in class Image
-
Returns color at specified positions of current image
AbstractFont::getFile() — Method in class AbstractFont
-
Gets the fontfile for current font
AbstractFont::getSize() — Method in class AbstractFont
-
Gets font's integer point size
AbstractFont::getColor() — Method in class AbstractFont
-
Gets font's color
AbstractImagine::getMetadataReader() — Method in class AbstractImagine
-
-
AbstractLayers::get() — Method in class AbstractLayers
-
Returns the image at offset
Box::getWidth() — Method in class Box
-
Gets current image width
Box::getHeight() — Method in class Box
-
Gets current image height
BoxInterface::getHeight() — Method in class BoxInterface
-
Gets current image height
BoxInterface::getWidth() — Method in class BoxInterface
-
Gets current image width
FillInterface::getColor() — Method in class FillInterface
-
Gets color of the fill for the given position
Horizontal::getDistance() — Method in class Horizontal
-
{@inheritdoc}
Linear::getColor() — Method in class Linear
-
Gets color of the fill for the given position
Linear::getStart() — Method in class Linear
-
-
Linear::getEnd() — Method in class Linear
-
-
Vertical::getDistance() — Method in class Vertical
-
{@inheritdoc}
FontInterface::getFile() — Method in class FontInterface
-
Gets the fontfile for current font
FontInterface::getSize() — Method in class FontInterface
-
Gets font's integer point size
FontInterface::getColor() — Method in class FontInterface
-
Gets font's color
ImageInterface::get() — Method in class ImageInterface
-
Returns the image content as a binary string
ImageInterface::getSize() — Method in class ImageInterface
-
Returns current image size
ImageInterface::getColorAt() — Method in class ImageInterface
-
Returns color at specified positions of current image
LayersInterface::get() — Method in class LayersInterface
-
Returns the image at offset
MetadataBag::getIterator() — Method in class MetadataBag
-
{@inheritdoc}
CMYK::getValue() — Method in class CMYK
+
Returns a list of filters sorted by their priority. Filters with same priority will be returned in the order they were added.
Effects::gamma() — Method in class Effects
+
Apply gamma correction.
Effects::grayscale() — Method in class Effects
+
Grayscale the image.
Image::getGdResource() — Method in class Image
+
Returns Gd resource.
Image::get() — Method in class Image
+
Returns the image content as a binary string.
Image::getSize() — Method in class Image
+
Returns current image size.
Image::getColorAt() — Method in class Image
+
Returns color at specified positions of current image.
Effects::gamma() — Method in class Effects
+
Apply gamma correction.
Effects::grayscale() — Method in class Effects
+
Grayscale the image.
Image::getGmagick() — Method in class Image
+
Returns gmagick instance.
Image::get() — Method in class Image
+
Returns the image content as a binary string.
Image::getSize() — Method in class Image
+
Returns current image size.
Image::getColorAt() — Method in class Image
+
Returns color at specified positions of current image.
AbstractFont::getFile() — Method in class AbstractFont
+
Gets the fontfile for current font.
AbstractFont::getSize() — Method in class AbstractFont
+
Gets font's integer point size.
AbstractFont::getColor() — Method in class AbstractFont
+
Gets font's color.
AbstractFont::getClassFactory() — Method in class AbstractFont
+
Get the class factory instance to be used.
AbstractImage::getAllThumbnailModes() — Method in class AbstractImage
+
Get all the available thumbnail modes.
AbstractImage::getClassFactory() — Method in class AbstractImage
+
Get the class factory instance to be used.
AbstractImagine::getMetadataReader() — Method in class AbstractImagine
+
Get the object to be used to read image metadata.
AbstractImagine::getClassFactory() — Method in class AbstractImagine
+
Get the class factory instance to be used.
AbstractLayers::get() — Method in class AbstractLayers
+
Returns the image at offset.
AbstractLayers::getClassFactory() — Method in class AbstractLayers
+
Get the class factory instance to be used.
Box::getWidth() — Method in class Box
+
Gets box width.
Box::getHeight() — Method in class Box
+
Gets box height.
BoxInterface::getHeight() — Method in class BoxInterface
+
Gets box height.
BoxInterface::getWidth() — Method in class BoxInterface
+
Gets box width.
FillInterface::getColor() — Method in class FillInterface
+
Gets color of the fill for the given position.
Horizontal::getDistance() — Method in class Horizontal
+
Get the distance of the position relative to the beginning of the gradient.
Linear::getColor() — Method in class Linear
+
Gets color of the fill for the given position.
Linear::getStart() — Method in class Linear
+
Linear::getEnd() — Method in class Linear
+
Linear::getDistance() — Method in class Linear
+
Get the distance of the position relative to the beginning of the gradient.
Vertical::getDistance() — Method in class Vertical
+
Get the distance of the position relative to the beginning of the gradient.
FontInterface::getFile() — Method in class FontInterface
+
Gets the fontfile for current font.
FontInterface::getSize() — Method in class FontInterface
+
Gets font's integer point size.
FontInterface::getColor() — Method in class FontInterface
+
Gets font's color.
ImageInterface::get() — Method in class ImageInterface
+
Returns the image content as a binary string.
ImageInterface::getSize() — Method in class ImageInterface
+
Returns current image size.
ImageInterface::getColorAt() — Method in class ImageInterface
+
Returns color at specified positions of current image.
ImagineInterface::getMetadataReader() — Method in class ImagineInterface
+
Get the object to be used to read image metadata.
LayersInterface::get() — Method in class LayersInterface
+
Returns the image at offset.
ExifMetadataReader::getUnsupportedReason() — Method in class ExifMetadataReader
+
Get the reason why this metadata reader is not supported.
MetadataBag::get() — Method in class MetadataBag
+
Returns the metadata key, default value if it does not exist.
MetadataBag::getIterator() — Method in class MetadataBag
+
{@inheritdoc}
CMYK::getChannelsMaxValue() — Method in class CMYK
+
Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).
CMYK::getValue() — Method in class CMYK
Return the value of one of the component.
CMYK::getCyan() — Method in class CMYK
-
Returns Cyan value of the color
CMYK::getMagenta() — Method in class CMYK
-
Returns Magenta value of the color
CMYK::getYellow() — Method in class CMYK
-
Returns Yellow value of the color
CMYK::getKeyline() — Method in class CMYK
-
Returns Key value of the color
CMYK::getPalette() — Method in class CMYK
-
Returns the palette attached to the current color
CMYK::getAlpha() — Method in class CMYK
-
Returns percentage of transparency of the color
CMYK::grayscale() — Method in class CMYK
-
Returns a gray related to the current color
ColorInterface::getValue() — Method in class ColorInterface
+
Returns Cyan value of the color (from 0 to 100).
CMYK::getMagenta() — Method in class CMYK
+
Returns Magenta value of the color (from 0 to 100).
CMYK::getYellow() — Method in class CMYK
+
Returns Yellow value of the color (from 0 to 100).
CMYK::getKeyline() — Method in class CMYK
+
Returns Key value of the color (from 0 to 100).
CMYK::getPalette() — Method in class CMYK
+
Returns the palette attached to the current color.
CMYK::getAlpha() — Method in class CMYK
+
Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).
CMYK::grayscale() — Method in class CMYK
+
Returns a gray related to the current color.
ColorInterface::getValue() — Method in class ColorInterface
Return the value of one of the component.
ColorInterface::getAlpha() — Method in class ColorInterface
-
Returns percentage of transparency of the color
ColorInterface::getPalette() — Method in class ColorInterface
-
Returns the palette attached to the current color
ColorInterface::grayscale() — Method in class ColorInterface
-
Returns a gray related to the current color
Gray — Class in namespace Imagine\Image\Palette\Color
-
-
Gray::getValue() — Method in class Gray
+
Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).
ColorInterface::getPalette() — Method in class ColorInterface
+
Returns the palette attached to the current color.
ColorInterface::grayscale() — Method in class ColorInterface
+
Returns a gray related to the current color.
Gray — Class in namespace Imagine\Image\Palette\Color
+
Gray::getValue() — Method in class Gray
Return the value of one of the component.
Gray::getGray() — Method in class Gray
-
Returns Gray value of the color
Gray::getPalette() — Method in class Gray
-
Returns the palette attached to the current color
Gray::getAlpha() — Method in class Gray
-
Returns percentage of transparency of the color
Gray::grayscale() — Method in class Gray
-
Returns a gray related to the current color
RGB::getValue() — Method in class RGB
+
Returns Gray value of the color (from 0 to 255).
Gray::getPalette() — Method in class Gray
+
Returns the palette attached to the current color.
Gray::getAlpha() — Method in class Gray
+
Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).
Gray::grayscale() — Method in class Gray
+
Returns a gray related to the current color.
RGB::getValue() — Method in class RGB
Return the value of one of the component.
RGB::getRed() — Method in class RGB
-
Returns RED value of the color
RGB::getGreen() — Method in class RGB
-
Returns GREEN value of the color
RGB::getBlue() — Method in class RGB
-
Returns BLUE value of the color
RGB::getPalette() — Method in class RGB
-
Returns the palette attached to the current color
RGB::getAlpha() — Method in class RGB
-
Returns percentage of transparency of the color
RGB::grayscale() — Method in class RGB
-
Returns a gray related to the current color
Grayscale — Class in namespace Imagine\Image\Palette
-
-
Point::getX() — Method in class Point
-
Gets points x coordinate
Point::getY() — Method in class Point
-
Gets points y coordinate
PointInterface::getX() — Method in class PointInterface
-
Gets points x coordinate
PointInterface::getY() — Method in class PointInterface
-
Gets points y coordinate
Center::getX() — Method in class Center
-
Gets points x coordinate
Center::getY() — Method in class Center
-
Gets points y coordinate
Effects::gamma() — Method in class Effects
-
Apply gamma correction
Effects::grayscale() — Method in class Effects
-
Grayscale the image
Image::getImagick() — Method in class Image
-
Returns the underlying \Imagick instance
Image::get() — Method in class Image
-
Returns the image content as a binary string
Image::getSize() — Method in class Image
-
Returns current image size
Image::getColorAt() — Method in class Image
-
Returns color at specified positions of current image

H

-
Image::histogram() — Method in class Image
-
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances
Image::histogram() — Method in class Image
-
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances
AbstractLayers::has() — Method in class AbstractLayers
-
Returns true if a layer at offset is preset
Box::heighten() — Method in class Box
-
Resizes box to given height, constraining proportions and returns the new box
BoxInterface::heighten() — Method in class BoxInterface
-
Resizes box to given height, constraining proportions and returns the new box
Horizontal — Class in namespace Imagine\Image\Fill\Gradient
-
Horizontal gradient fill
ImageInterface::histogram() — Method in class ImageInterface
-
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances
LayersInterface::has() — Method in class LayersInterface
-
Returns true if a layer at offset is preset
Image::histogram() — Method in class Image
-
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances

I

+
Returns RED value of the color (from 0 to 255).
RGB::getGreen() — Method in class RGB
+
Returns GREEN value of the color (from 0 to 255).
RGB::getBlue() — Method in class RGB
+
Returns BLUE value of the color (from 0 to 255).
RGB::getPalette() — Method in class RGB
+
Returns the palette attached to the current color.
RGB::getAlpha() — Method in class RGB
+
Returns percentage of transparency of the color (from 0 - fully transparent, to 100 - fully opaque).
RGB::grayscale() — Method in class RGB
+
Returns a gray related to the current color.
Grayscale — Class in namespace Imagine\Image\Palette
+
The grayscale palette.
Grayscale::getChannelsMaxValue() — Method in class Grayscale
+
Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).
PaletteInterface::getChannelsMaxValue() — Method in class PaletteInterface
+
Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).
RGB::getChannelsMaxValue() — Method in class RGB
+
Get the max value of palette components (255 for RGB and Grayscale, 100 for CMYK).
Point::getX() — Method in class Point
+
Gets points x coordinate.
Point::getY() — Method in class Point
+
Gets points y coordinate.
PointInterface::getX() — Method in class PointInterface
+
Gets points x coordinate.
PointInterface::getY() — Method in class PointInterface
+
Gets points y coordinate.
PointSigned::getX() — Method in class PointSigned
+
Gets points x coordinate.
PointSigned::getY() — Method in class PointSigned
+
Gets points y coordinate.
Center::getX() — Method in class Center
+
Gets points x coordinate.
Center::getY() — Method in class Center
+
Gets points y coordinate.
Effects::gamma() — Method in class Effects
+
Apply gamma correction.
Effects::grayscale() — Method in class Effects
+
Grayscale the image.
Image::getImagick() — Method in class Image
+
Returns the underlying \Imagick instance.
Image::get() — Method in class Image
+
Returns the image content as a binary string.
Image::getSize() — Method in class Image
+
Returns current image size.
Image::getColorAt() — Method in class Image
+
Returns color at specified positions of current image.
Matrix::getWidth() — Method in class Matrix
+
Get the matrix width.
Matrix::getHeight() — Method in class Matrix
+
Get the matrix height.
Matrix::getElementAt() — Method in class Matrix
+
Get the value of a cell.
Matrix::getValueList() — Method in class Matrix
+
Return all the matrix values, as a monodimensional array.
Matrix::getMatrix() — Method in class Matrix
+
Return all the matrix values, as a bidimensional array (every array item contains the values of a row).

H

+
Loader::hasReadData() — Method in class Loader
+
Is the binary content already loaded?
LoaderInterface::hasReadData() — Method in class LoaderInterface
+
Is the binary content already loaded?
Image::histogram() — Method in class Image
+
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.
Image::histogram() — Method in class Image
+
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.
AbstractLayers::has() — Method in class AbstractLayers
+
Returns true if a layer at offset is preset.
Box::heighten() — Method in class Box
+
Resizes box to given height, constraining proportions and returns the new box.
BoxInterface::heighten() — Method in class BoxInterface
+
Resizes box to given height, constraining proportions and returns the new box.
Horizontal — Class in namespace Imagine\Image\Fill\Gradient
+
Horizontal gradient fill.
ImageInterface::histogram() — Method in class ImageInterface
+
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.
LayersInterface::has() — Method in class LayersInterface
+
Returns true if a layer at offset is preset.
Image::histogram() — Method in class Image
+
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.
$Matrix#height — Property in class Matrix
+
The matrix height.

I

InvalidArgumentException — Class in namespace Imagine\Exception
-
Imagine-specific invalid argument exception
ImagineAware — Class in namespace Imagine\Filter
-
ImagineAware base class
Image — Class in namespace Imagine\Gd
-
Image implementation using the GD library
Image::interlace() — Method in class Image
-
Enables or disables interlacing
Imagine — Class in namespace Imagine\Gd
-
Imagine implementation using the GD library
Image — Class in namespace Imagine\Gmagick
-
Image implementation using the Gmagick PHP extension
Image::interlace() — Method in class Image
-
Enables or disables interlacing
Imagine — Class in namespace Imagine\Gmagick
-
Imagine implementation using the Gmagick PHP extension
Box::increase() — Method in class Box
-
Creates new BoxInterface, adding given size to both sides
BoxInterface::increase() — Method in class BoxInterface
-
Creates new BoxInterface, adding given size to both sides
ImageInterface — Class in namespace Imagine\Image
-
The image interface
ImageInterface::interlace() — Method in class ImageInterface
-
Enables or disables interlacing
ImagineInterface — Class in namespace Imagine\Image
-
The imagine interface
CMYK::isOpaque() — Method in class CMYK
-
Checks if the current color is opaque
ColorInterface::isOpaque() — Method in class ColorInterface
-
Checks if the current color is opaque
Gray::isOpaque() — Method in class Gray
-
Checks if the current color is opaque
RGB::isOpaque() — Method in class RGB
-
Checks if the current color is opaque
Point::in() — Method in class Point
-
Checks if current coordinate is inside a given bo
PointInterface::in() — Method in class PointInterface
-
Checks if current coordinate is inside a given bo
Center::in() — Method in class Center
-
Checks if current coordinate is inside a given bo
Image — Class in namespace Imagine\Imagick
-
Image implementation using the Imagick PHP extension
Image::interlace() — Method in class Image
-
Enables or disables interlacing
Imagine — Class in namespace Imagine\Imagick
-
Imagine implementation using the Imagick PHP extension
IsImageEqual — Class in namespace Imagine\Test\Constraint
-
-
ImagineTestCase — Class in namespace Imagine\Test
-
-

K

+
Imagine-specific invalid argument exception.
$Loader#isUrl — Property in class Loader
+
Does $path contain an URL?
$Loader#isCurlSupported — Property in class Loader
+
Is curl available, with a decent version?
Loader::isLocalFile() — Method in class Loader
+
Is this a local file.
Loader::isCurlSupported() — Method in class Loader
+
Check if curl is available and it's a decent version.
LoaderInterface::isLocalFile() — Method in class LoaderInterface
+
Is this a local file.
ImagineAware — Class in namespace Imagine\Filter
+
ImagineAware base class.
Image — Class in namespace Imagine\Gd
+
Image implementation using the GD library.
Image::interlace() — Method in class Image
+
Enables or disables interlacing.
Imagine — Class in namespace Imagine\Gd
+
Imagine implementation using the GD library.
Image — Class in namespace Imagine\Gmagick
+
Image implementation using the Gmagick PHP extension.
Image::interlace() — Method in class Image
+
Enables or disables interlacing.
Imagine — Class in namespace Imagine\Gmagick
+
Imagine implementation using the Gmagick PHP extension.
Box::increase() — Method in class Box
+
Creates new BoxInterface, adding given size to both sides.
BoxInterface::increase() — Method in class BoxInterface
+
Creates new BoxInterface, adding given size to both sides.
ImageInterface — Class in namespace Imagine\Image
+
The image interface.
ImageInterface::interlace() — Method in class ImageInterface
+
Enables or disables interlacing.
ImagineInterface — Class in namespace Imagine\Image
+
The imagine interface.
ExifMetadataReader::isSupported() — Method in class ExifMetadataReader
+
Is this metadata reader supported?
CMYK::isOpaque() — Method in class CMYK
+
Checks if the current color is opaque.
ColorInterface::isOpaque() — Method in class ColorInterface
+
Checks if the current color is opaque.
Gray::isOpaque() — Method in class Gray
+
Checks if the current color is opaque.
RGB::isOpaque() — Method in class RGB
+
Checks if the current color is opaque.
Point::in() — Method in class Point
+
Checks if current coordinate is inside a given box.
PointInterface::in() — Method in class PointInterface
+
Checks if current coordinate is inside a given box.
PointSigned::in() — Method in class PointSigned
+
Checks if current coordinate is inside a given box.
Center::in() — Method in class Center
+
Checks if current coordinate is inside a given box.
Image — Class in namespace Imagine\Imagick
+
Image implementation using the Imagick PHP extension.
Image::interlace() — Method in class Image
+
Enables or disables interlacing.
Imagine — Class in namespace Imagine\Imagick
+
Imagine implementation using the Imagick PHP extension.
ErrorHandling::ignoring() — Method in class ErrorHandling
+
Call a callback ignoring $flags warnings.

K

Layers::key() — Method in class Layers
{@inheritdoc}
Layers::key() — Method in class Layers
{@inheritdoc}
Layers::key() — Method in class Layers
{@inheritdoc}

L

DrawerInterface::line() — Method in class DrawerInterface
-
Draws a line from start(x, y) to end(x, y) coordinates
Drawer::line() — Method in class Drawer
-
Draws a line from start(x, y) to end(x, y) coordinates
Image::layers() — Method in class Image
+
Draws a line from start(x, y) to end(x, y) coordinates.
Loader — Class in namespace Imagine\File
+
Default implementation of Imagine\File\LoaderInterface.
LoaderInterface — Class in namespace Imagine\File
+
Interface for classes that can load local or remote files.
Drawer::line() — Method in class Drawer
+
Draws a line from start(x, y) to end(x, y) coordinates.
Image::layers() — Method in class Image
Returns the image layers when applicable.
Imagine::load() — Method in class Imagine
-
Loads an image from a binary $string
Layers — Class in namespace Imagine\Gd
-
-
Drawer::line() — Method in class Drawer
-
Draws a line from start(x, y) to end(x, y) coordinates
Image::layers() — Method in class Image
+
Loads an image from a binary $string.
Layers — Class in namespace Imagine\Gd
+
Drawer::line() — Method in class Drawer
+
Draws a line from start(x, y) to end(x, y) coordinates.
Image::layers() — Method in class Image
Returns the image layers when applicable.
Imagine::load() — Method in class Imagine
-
Loads an image from a binary $string
Layers — Class in namespace Imagine\Gmagick
-
-
Linear — Class in namespace Imagine\Image\Fill\Gradient
-
Linear gradient fill
ImageInterface::layers() — Method in class ImageInterface
+
Loads an image from a binary $string.
Layers — Class in namespace Imagine\Gmagick
+
Linear — Class in namespace Imagine\Image\Fill\Gradient
+
Linear gradient fill.
ImageInterface::layers() — Method in class ImageInterface
Returns the image layers when applicable.
ImagineInterface::load() — Method in class ImagineInterface
-
Loads an image from a binary $string
LayersInterface — Class in namespace Imagine\Image
-
The layers interface
CMYK::lighten() — Method in class CMYK
-
Returns a copy of the current color, lightened by the specified number of shades
ColorInterface::lighten() — Method in class ColorInterface
-
Returns a copy of the current color, lightened by the specified number of shades
Gray::lighten() — Method in class Gray
-
Returns a copy of the current color, lightened by the specified number of shades
RGB::lighten() — Method in class RGB
-
Returns a copy of the current color, lightened by the specified number of shades
Drawer::line() — Method in class Drawer
-
Draws a line from start(x, y) to end(x, y) coordinates
Image::layers() — Method in class Image
+
Loads an image from a binary $string.
LayersInterface — Class in namespace Imagine\Image
+
The layers interface.
CMYK::lighten() — Method in class CMYK
+
Returns a copy of the current color, lightened by the specified number of shades.
ColorInterface::lighten() — Method in class ColorInterface
+
Returns a copy of the current color, lightened by the specified number of shades.
Gray::lighten() — Method in class Gray
+
Returns a copy of the current color, lightened by the specified number of shades.
RGB::lighten() — Method in class RGB
+
Returns a copy of the current color, lightened by the specified number of shades.
Drawer::line() — Method in class Drawer
+
Draws a line from start(x, y) to end(x, y) coordinates.
Image::layers() — Method in class Image
Returns the image layers when applicable.
Imagine::load() — Method in class Imagine
-
Loads an image from a binary $string
Layers — Class in namespace Imagine\Imagick
-
-

M

-
Image::mask() — Method in class Image
-
Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified
Layers::merge() — Method in class Layers
-
Merge layers into the original objects
Image::mask() — Method in class Image
-
Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified
Layers::merge() — Method in class Layers
-
Merge layers into the original objects
AbstractImage::metadata() — Method in class AbstractImage
-
Returns the Image's meta data
ImageInterface::mask() — Method in class ImageInterface
-
Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified
ImageInterface::metadata() — Method in class ImageInterface
-
Returns the Image's meta data
LayersInterface::merge() — Method in class LayersInterface
-
Merge layers into the original objects
ManipulatorInterface — Class in namespace Imagine\Image
-
The manipulator interface
MetadataBag — Class in namespace Imagine\Image\Metadata
-
An interface for Image Metadata
MetadataReaderInterface — Class in namespace Imagine\Image\Metadata
-
-
Point::move() — Method in class Point
-
Returns another point, moved by a given amount from current coordinates
PointInterface::move() — Method in class PointInterface
-
Returns another point, moved by a given amount from current coordinates
Center::move() — Method in class Center
-
Returns another point, moved by a given amount from current coordinates
Image::mask() — Method in class Image
-
Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified
Layers::merge() — Method in class Layers
-
Merge layers into the original objects

N

+
Loads an image from a binary $string.
Layers — Class in namespace Imagine\Imagick
+

M

+
$Neighborhood#matrix — Property in class Neighborhood
+
Image::mask() — Method in class Image
+
Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.
Layers::merge() — Method in class Layers
+
Merge layers into the original objects.
Image::mask() — Method in class Image
+
Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.
Layers::merge() — Method in class Layers
+
Merge layers into the original objects.
$AbstractImage#metadata — Property in class AbstractImage
+
AbstractImage::metadata() — Method in class AbstractImage
+
Returns the Image's meta data.
ImageInterface::mask() — Method in class ImageInterface
+
Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.
ImageInterface::metadata() — Method in class ImageInterface
+
Returns the Image's meta data.
LayersInterface::merge() — Method in class LayersInterface
+
Merge layers into the original objects.
ManipulatorInterface — Class in namespace Imagine\Image
+
The manipulator interface.
MetadataBag — Class in namespace Imagine\Image\Metadata
+
The container of the data extracted from metadata.
MetadataReaderInterface — Class in namespace Imagine\Image\Metadata
+
Interface that metadata readers must implement.
Point::move() — Method in class Point
+
Returns another point, moved by a given amount from current coordinates.
PointInterface::move() — Method in class PointInterface
+
Returns another point, moved by a given amount from current coordinates.
PointSigned::move() — Method in class PointSigned
+
Returns another point, moved by a given amount from current coordinates.
Center::move() — Method in class Center
+
Returns another point, moved by a given amount from current coordinates.
Image::mask() — Method in class Image
+
Transforms creates a grayscale mask from current image, returns a new +image, while keeping the existing image unmodified.
Layers::merge() — Method in class Layers
+
Merge layers into the original objects.
Matrix — Class in namespace Imagine\Utils
+

N

EffectsInterface::negative() — Method in class EffectsInterface
-
Invert the colors of the image
NotSupportedException — Class in namespace Imagine\Exception
-
Should be used when a driver does not support an operation.
Effects::negative() — Method in class Effects
-
Invert the colors of the image
Layers::next() — Method in class Layers
+
Invert the colors of the image.
NotSupportedException — Class in namespace Imagine\Exception
+
Should be used when a driver does not support an operation.
Negation — Class in namespace Imagine\Filter\Advanced
+
This filter negates every color of every pixel of an image.
Neighborhood — Class in namespace Imagine\Filter\Advanced
+
The Neighborhood filter takes a matrix and calculates the color current pixel based on its neighborhood.
Effects::negative() — Method in class Effects
+
Invert the colors of the image.
Layers::next() — Method in class Layers
{@inheritdoc}
Effects::negative() — Method in class Effects
-
Invert the colors of the image
Layers::next() — Method in class Layers
+
Invert the colors of the image.
Layers::next() — Method in class Layers
{@inheritdoc}
CMYK::name() — Method in class CMYK
-
Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants
Grayscale::name() — Method in class Grayscale
-
Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants
PaletteInterface::name() — Method in class PaletteInterface
-
Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants
RGB::name() — Method in class RGB
-
Returns the name of this Palette, one of PaletteInterface::PALETTE_* constants
Profile::name() — Method in class Profile
-
Returns the name of the profile
ProfileInterface::name() — Method in class ProfileInterface
-
Returns the name of the profile
Effects::negative() — Method in class Effects
-
Invert the colors of the image
Layers::next() — Method in class Layers
-
{@inheritdoc}

O

+
Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.
Grayscale::name() — Method in class Grayscale
+
Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.
PaletteInterface::name() — Method in class PaletteInterface
+
Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.
RGB::name() — Method in class RGB
+
Returns the name of this Palette, one of PaletteInterface::PALETTE_ constants.
Profile::name() — Method in class Profile
+
Returns the name of the profile.
ProfileInterface::name() — Method in class ProfileInterface
+
Returns the name of the profile.
Effects::negative() — Method in class Effects
+
Invert the colors of the image.
Layers::next() — Method in class Layers
+
{@inheritdoc}
Matrix::normalize() — Method in class Matrix
+
Returns a new Matrix instance, representing the normalized value of this matrix.

O

OutOfBoundsException — Class in namespace Imagine\Exception
-
Imagine-specific out of bounds exception
OnPixelBased — Class in namespace Imagine\Filter\Advanced
-
The OnPixelBased takes a callable, and for each pixel, this callable is called with the image (\Imagine\Image\ImageInterface) and the current point (\Imagine\Image\Point)
Imagine::open() — Method in class Imagine
-
Opens an existing image from $path
Layers::offsetExists() — Method in class Layers
+
Imagine-specific out of bounds exception.
OnPixelBased — Class in namespace Imagine\Filter\Advanced
+
The OnPixelBased takes a callable, and for each pixel, this callable is called with the +image (\Imagine\Image\ImageInterface) and the current point (\Imagine\Image\Point).
Imagine::open() — Method in class Imagine
+
Opens an existing image from $path.
Layers::offsetExists() — Method in class Layers
{@inheritdoc}
Layers::offsetGet() — Method in class Layers
{@inheritdoc}
Layers::offsetSet() — Method in class Layers
{@inheritdoc}
Layers::offsetUnset() — Method in class Layers
{@inheritdoc}
Imagine::open() — Method in class Imagine
-
Opens an existing image from $path
Layers::offsetExists() — Method in class Layers
+
Opens an existing image from $path.
Layers::offsetExists() — Method in class Layers
{@inheritdoc}
Layers::offsetGet() — Method in class Layers
{@inheritdoc}
Layers::offsetSet() — Method in class Layers
{@inheritdoc}
Layers::offsetUnset() — Method in class Layers
{@inheritdoc}
ImagineInterface::open() — Method in class ImagineInterface
-
Opens an existing image from $path
MetadataBag::offsetExists() — Method in class MetadataBag
+
Opens an existing image from $path.
MetadataBag::offsetExists() — Method in class MetadataBag
{@inheritdoc}
MetadataBag::offsetSet() — Method in class MetadataBag
{@inheritdoc}
MetadataBag::offsetUnset() — Method in class MetadataBag
{@inheritdoc}
MetadataBag::offsetGet() — Method in class MetadataBag
{@inheritdoc}
Imagine::open() — Method in class Imagine
-
Opens an existing image from $path
Layers::offsetExists() — Method in class Layers
+
Opens an existing image from $path.
Layers::offsetExists() — Method in class Layers
{@inheritdoc}
Layers::offsetGet() — Method in class Layers
{@inheritdoc}
Layers::offsetSet() — Method in class Layers
{@inheritdoc}
Layers::offsetUnset() — Method in class Layers
{@inheritdoc}

P

DrawerInterface::pieSlice() — Method in class DrawerInterface
-
Same as arc, but connects end points and the center
DrawerInterface::polygon() — Method in class DrawerInterface
-
Draws a polygon using array of x, y coordinates.
Paste — Class in namespace Imagine\Filter\Basic
-
A paste filter
Transformation::paste() — Method in class Transformation
-
Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails
Drawer::pieSlice() — Method in class Drawer
-
Same as arc, but connects end points and the center
Drawer::polygon() — Method in class Drawer
-
Draws a polygon using array of x, y coordinates.
Image::paste() — Method in class Image
-
Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails
Image::palette() — Method in class Image
-
Return the current color palette
Image::profile() — Method in class Image
-
Applies a color profile on the Image
Drawer::pieSlice() — Method in class Drawer
-
Same as arc, but connects end points and the center
Drawer::polygon() — Method in class Drawer
-
Draws a polygon using array of x, y coordinates.
Image::paste() — Method in class Image
-
Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails
Image::pixelToColor() — Method in class Image
-
Returns a color given a pixel, depending the Palette context
Image::palette() — Method in class Image
-
Return the current color palette
Image::profile() — Method in class Image
-
Applies a color profile on the Image
ImageInterface::palette() — Method in class ImageInterface
-
Return the current color palette
ImageInterface::profile() — Method in class ImageInterface
-
Applies a color profile on the Image
ManipulatorInterface::paste() — Method in class ManipulatorInterface
-
Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails
CMYK::pixelDefinition() — Method in class CMYK
-
Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.
CMYK::profile() — Method in class CMYK
+
Same as arc, but connects end points and the center.
DrawerInterface::polygon() — Method in class DrawerInterface
+
Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.
$Loader#path — Property in class Loader
+
The file path.
Paste — Class in namespace Imagine\Filter\Basic
+
A paste filter.
Transformation::paste() — Method in class Transformation
+
Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.
Drawer::pieSlice() — Method in class Drawer
+
Same as arc, but connects end points and the center.
Drawer::polygon() — Method in class Drawer
+
Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.
Image::paste() — Method in class Image
+
Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.
Image::palette() — Method in class Image
+
Return the current color palette.
Image::profile() — Method in class Image
+
Applies a color profile on the Image.
Drawer::pieSlice() — Method in class Drawer
+
Same as arc, but connects end points and the center.
Drawer::polygon() — Method in class Drawer
+
Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.
Image::paste() — Method in class Image
+
Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.
Image::pixelToColor() — Method in class Image
+
Returns a color given a pixel, depending the Palette context.
Image::palette() — Method in class Image
+
Return the current color palette.
Image::profile() — Method in class Image
+
Applies a color profile on the Image.
ImageInterface::palette() — Method in class ImageInterface
+
Return the current color palette.
ImageInterface::profile() — Method in class ImageInterface
+
Applies a color profile on the Image.
ManipulatorInterface::paste() — Method in class ManipulatorInterface
+
Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.
CMYK::pixelDefinition() — Method in class CMYK
+
Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.
CMYK::profile() — Method in class CMYK
Returns the ICC profile attached to this Palette.
ColorParser::parseToRGB() — Method in class ColorParser
-
Parses a color to a RGB tuple
ColorParser::parseToCMYK() — Method in class ColorParser
-
Parses a color to a CMYK tuple
ColorParser::parseToGrayscale() — Method in class ColorParser
-
Parses a color to a grayscale value
Grayscale::pixelDefinition() — Method in class Grayscale
-
Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.
Grayscale::profile() — Method in class Grayscale
+
Parses a color to a RGB tuple.
ColorParser::parseToCMYK() — Method in class ColorParser
+
Parses a color to a CMYK tuple.
ColorParser::parseToGrayscale() — Method in class ColorParser
+
Parses a color to a grayscale value.
Grayscale::pixelDefinition() — Method in class Grayscale
+
Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.
Grayscale::profile() — Method in class Grayscale
Returns the ICC profile attached to this Palette.
PaletteInterface — Class in namespace Imagine\Image\Palette
-
-
PaletteInterface::profile() — Method in class PaletteInterface
+
Interface that any palette must implement.
PaletteInterface::profile() — Method in class PaletteInterface
Returns the ICC profile attached to this Palette.
PaletteInterface::pixelDefinition() — Method in class PaletteInterface
-
Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.
RGB::pixelDefinition() — Method in class RGB
-
Returns an array containing ColorInterface::COLOR_* constants that define the structure of colors for a pixel.
RGB::profile() — Method in class RGB
+
Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.
RGB::pixelDefinition() — Method in class RGB
+
Returns an array containing ColorInterface::COLOR_* constants that +define the structure of colors for a pixel.
RGB::profile() — Method in class RGB
Returns the ICC profile attached to this Palette.
Point — Class in namespace Imagine\Image
-
The point class
PointInterface — Class in namespace Imagine\Image
-
The point interface
Profile — Class in namespace Imagine\Image
-
-
ProfileInterface — Class in namespace Imagine\Image
-
-
Drawer::pieSlice() — Method in class Drawer
-
Same as arc, but connects end points and the center
Drawer::polygon() — Method in class Drawer
-
Draws a polygon using array of x, y coordinates.
Image::paste() — Method in class Image
-
Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails
Image::pixelToColor() — Method in class Image
-
Returns a color given a pixel, depending the Palette context
Image::palette() — Method in class Image
-
Return the current color palette
Image::profile() — Method in class Image
-
Applies a color profile on the Image

R

-
RuntimeException — Class in namespace Imagine\Exception
-
Imagine-specific runtime exception
RelativeResize — Class in namespace Imagine\Filter\Advanced
+
The point class.
PointInterface — Class in namespace Imagine\Image
+
The point interface.
PointSigned — Class in namespace Imagine\Image
+
A point class that allows negative values of coordinates.
Profile — Class in namespace Imagine\Image
+
The default implementation of ProfileInterface.
ProfileInterface — Class in namespace Imagine\Image
+
Drawer::pieSlice() — Method in class Drawer
+
Same as arc, but connects end points and the center.
Drawer::polygon() — Method in class Drawer
+
Draws a polygon using array of x, y coordinates. Must contain at least three coordinates.
Image::paste() — Method in class Image
+
Pastes an image into a parent image +Throws exceptions if image exceeds parent image borders or if paste +operation fails.
Image::pixelToColor() — Method in class Image
+
Returns a color given a pixel, depending the Palette context.
Image::palette() — Method in class Image
+
Return the current color palette.
Image::profile() — Method in class Image
+
Applies a color profile on the Image.

R

+
DrawerInterface::rectangle() — Method in class DrawerInterface
+
Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.
RuntimeException — Class in namespace Imagine\Exception
+
Imagine-specific runtime exception.
Loader::readLocalFile() — Method in class Loader
+
Read a local file.
Loader::readRemoteFile() — Method in class Loader
+
Read a remote file.
Loader::readRemoteFileWithCurl() — Method in class Loader
+
Read a remote file using the cURL extension.
Loader::readRemoteFileWithFileGetContents() — Method in class Loader
+
Read a remote file using the file_get_contents.
RelativeResize — Class in namespace Imagine\Filter\Advanced
The RelativeResize filter allows images to be resized relative to their existing dimensions.
Resize — Class in namespace Imagine\Filter\Basic
-
A resize filter
Rotate — Class in namespace Imagine\Filter\Basic
-
A rotate filter
Transformation::resize() — Method in class Transformation
-
Resizes current image and returns self
Transformation::rotate() — Method in class Transformation
-
Rotates an image at the given angle.
Image::resize() — Method in class Image
-
Resizes current image and returns self
Image::rotate() — Method in class Image
+
A resize filter.
Rotate — Class in namespace Imagine\Filter\Basic
+
A rotate filter.
Transformation::resize() — Method in class Transformation
+
Resizes current image and returns self.
Transformation::rotate() — Method in class Transformation
+
Rotates an image at the given angle.
Drawer::rectangle() — Method in class Drawer
+
Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.
Image::resize() — Method in class Image
+
Resizes current image and returns self.
Image::rotate() — Method in class Image
Rotates an image at the given angle.
Imagine::read() — Method in class Imagine
-
Loads an image from a resource $resource
Layers::rewind() — Method in class Layers
-
{@inheritdoc}
Image::resize() — Method in class Image
-
Resizes current image and returns self
Image::rotate() — Method in class Image
+
Loads an image from a resource $resource.
Layers::rewind() — Method in class Layers
+
{@inheritdoc}
Drawer::rectangle() — Method in class Drawer
+
Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.
Image::resize() — Method in class Image
+
Resizes current image and returns self.
Image::rotate() — Method in class Image
Rotates an image at the given angle.
Imagine::read() — Method in class Imagine
-
Loads an image from a resource $resource
Layers::rewind() — Method in class Layers
+
Loads an image from a resource $resource.
Layers::rewind() — Method in class Layers
{@inheritdoc}
AbstractLayers::remove() — Method in class AbstractLayers
-
Removes the image at offset
Range — Class in namespace Imagine\Image\Histogram
-
Range histogram
ImagineInterface::read() — Method in class ImagineInterface
-
Loads an image from a resource $resource
LayersInterface::remove() — Method in class LayersInterface
-
Removes the image at offset
ManipulatorInterface::resize() — Method in class ManipulatorInterface
-
Resizes current image and returns self
ManipulatorInterface::rotate() — Method in class ManipulatorInterface
+
Removes the image at offset.
Range — Class in namespace Imagine\Image\Histogram
+
Range histogram.
ImagineInterface::read() — Method in class ImagineInterface
+
Loads an image from a resource $resource.
LayersInterface::remove() — Method in class LayersInterface
+
Removes the image at offset.
ManipulatorInterface::resize() — Method in class ManipulatorInterface
+
Resizes current image and returns self.
ManipulatorInterface::rotate() — Method in class ManipulatorInterface
Rotates an image at the given angle.
AbstractMetadataReader::readFile() — Method in class AbstractMetadataReader
Reads metadata from a file.
AbstractMetadataReader::readData() — Method in class AbstractMetadataReader
Reads metadata from a binary string.
AbstractMetadataReader::readStream() — Method in class AbstractMetadataReader
@@ -527,181 +708,195 @@

A

Reads metadata from a file.
MetadataReaderInterface::readData() — Method in class MetadataReaderInterface
Reads metadata from a binary string.
MetadataReaderInterface::readStream() — Method in class MetadataReaderInterface
Reads metadata from a stream.
RGB — Class in namespace Imagine\Image\Palette\Color
-
-
RGB — Class in namespace Imagine\Image\Palette
-
-
Image::resize() — Method in class Image
-
Resizes current image and returns self
Image::rotate() — Method in class Image
+
RGB — Class in namespace Imagine\Image\Palette
+
The RGB palette.
Drawer::rectangle() — Method in class Drawer
+
Draws a rectangle from left, top(x, y) to right, bottom(x, y) coordinates.
Image::resize() — Method in class Image
+
Resizes current image and returns self.
Image::rotate() — Method in class Image
Rotates an image at the given angle.
Imagine::read() — Method in class Imagine
-
Loads an image from a resource $resource
Layers::rewind() — Method in class Layers
+
Loads an image from a resource $resource.
Layers::rewind() — Method in class Layers
{@inheritdoc}

S

EffectsInterface::sharpen() — Method in class EffectsInterface
-
Sharpens the image
Save — Class in namespace Imagine\Filter\Basic
-
A save filter
Show — Class in namespace Imagine\Filter\Basic
-
A show filter
Strip — Class in namespace Imagine\Filter\Basic
-
A strip filter
ImagineAware::setImagine() — Method in class ImagineAware
+
Sharpens the image.
ClassFactoryAwareInterface::setClassFactory() — Method in class ClassFactoryAwareInterface
+
Set the class factory instance to be used.
Loader::setCurlOptions() — Method in class Loader
+
Set curl options.
Save — Class in namespace Imagine\Filter\Basic
+
A save filter.
Show — Class in namespace Imagine\Filter\Basic
+
A show filter.
Strip — Class in namespace Imagine\Filter\Basic
+
A strip filter.
ImagineAware::setImagine() — Method in class ImagineAware
Set ImagineInterface instance.
Transformation::strip() — Method in class Transformation
-
Remove all profiles and comments
Transformation::save() — Method in class Transformation
-
Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported
Transformation::show() — Method in class Transformation
-
Outputs the image content
Effects::sharpen() — Method in class Effects
-
Sharpens the image
Image::save() — Method in class Image
-
Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported
Image::show() — Method in class Image
-
Outputs the image content
Image::strip() — Method in class Image
-
Remove all profiles and comments
Effects::sharpen() — Method in class Effects
-
Sharpens the image
Image::strip() — Method in class Image
-
Remove all profiles and comments
Image::save() — Method in class Image
-
Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported
Image::show() — Method in class Image
-
Outputs the image content
AbstractImagine::setMetadataReader() — Method in class AbstractImagine
-
-
AbstractLayers::set() — Method in class AbstractLayers
-
Set an image at offset
Box::scale() — Method in class Box
-
Creates new BoxInterface instance with ratios applied to both sides
Box::square() — Method in class Box
-
Gets current box square, useful for getting total number of pixels in a given box
BoxInterface::scale() — Method in class BoxInterface
-
Creates new BoxInterface instance with ratios applied to both sides
BoxInterface::square() — Method in class BoxInterface
-
Gets current box square, useful for getting total number of pixels in a given box
LayersInterface::set() — Method in class LayersInterface
-
Set an image at offset
ManipulatorInterface::save() — Method in class ManipulatorInterface
-
Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported
ManipulatorInterface::show() — Method in class ManipulatorInterface
-
Outputs the image content
ManipulatorInterface::strip() — Method in class ManipulatorInterface
-
Remove all profiles and comments
CMYK::supportsAlpha() — Method in class CMYK
-
Tells if alpha channel is supported in this palette
Grayscale::supportsAlpha() — Method in class Grayscale
-
Tells if alpha channel is supported in this palette
PaletteInterface::supportsAlpha() — Method in class PaletteInterface
-
Tells if alpha channel is supported in this palette
RGB::supportsAlpha() — Method in class RGB
-
Tells if alpha channel is supported in this palette
Effects::sharpen() — Method in class Effects
-
Sharpens the image
Image::strip() — Method in class Image
-
Remove all profiles and comments
Image::save() — Method in class Image
-
Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp and xbm are supported
Image::show() — Method in class Image
-
Outputs the image content

T

+
Remove all profiles and comments.
Transformation::save() — Method in class Transformation
+
Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.
Transformation::show() — Method in class Transformation
+
Outputs the image content.
Effects::sharpen() — Method in class Effects
+
Sharpens the image.
Image::save() — Method in class Image
+
Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.
Image::show() — Method in class Image
+
Outputs the image content.
Image::strip() — Method in class Image
+
Remove all profiles and comments.
Effects::sharpen() — Method in class Effects
+
Sharpens the image.
Image::strip() — Method in class Image
+
Remove all profiles and comments.
Image::save() — Method in class Image
+
Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.
Image::show() — Method in class Image
+
Outputs the image content.
$AbstractFont#size — Property in class AbstractFont
+
AbstractFont::setClassFactory() — Method in class AbstractFont
+
Set the class factory instance to be used.
AbstractImage::setClassFactory() — Method in class AbstractImage
+
Set the class factory instance to be used.
AbstractImagine::setMetadataReader() — Method in class AbstractImagine
+
Set the object to be used to read image metadata.
AbstractImagine::setClassFactory() — Method in class AbstractImagine
+
Set the class factory instance to be used.
AbstractLayers::set() — Method in class AbstractLayers
+
Set an image at offset.
AbstractLayers::setClassFactory() — Method in class AbstractLayers
+
Set the class factory instance to be used.
Box::scale() — Method in class Box
+
Creates new BoxInterface instance with ratios applied to both sides.
Box::square() — Method in class Box
+
Gets current box square, useful for getting total number of pixels in a +given box.
BoxInterface::scale() — Method in class BoxInterface
+
Creates new BoxInterface instance with ratios applied to both sides.
BoxInterface::square() — Method in class BoxInterface
+
Gets current box square, useful for getting total number of pixels in a +given box.
ImagineInterface::setMetadataReader() — Method in class ImagineInterface
+
Set the object to be used to read image metadata.
LayersInterface::set() — Method in class LayersInterface
+
Set an image at offset.
ManipulatorInterface::save() — Method in class ManipulatorInterface
+
Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.
ManipulatorInterface::show() — Method in class ManipulatorInterface
+
Outputs the image content.
ManipulatorInterface::strip() — Method in class ManipulatorInterface
+
Remove all profiles and comments.
CMYK::supportsAlpha() — Method in class CMYK
+
Tells if alpha channel is supported in this palette.
Grayscale::supportsAlpha() — Method in class Grayscale
+
Tells if alpha channel is supported in this palette.
PaletteInterface::supportsAlpha() — Method in class PaletteInterface
+
Tells if alpha channel is supported in this palette.
RGB::supportsAlpha() — Method in class RGB
+
Tells if alpha channel is supported in this palette.
Effects::sharpen() — Method in class Effects
+
Sharpens the image.
Image::strip() — Method in class Image
+
Remove all profiles and comments.
Image::save() — Method in class Image
+
Saves the image at a specified path, the target file extension is used +to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are +supported.
Image::show() — Method in class Image
+
Outputs the image content.
Matrix::setElementAt() — Method in class Matrix
+
Set the value of a cell.

T

DrawerInterface::text() — Method in class DrawerInterface
-
Annotates image with specified text at a given position starting on the top left of the final text box
Thumbnail — Class in namespace Imagine\Filter\Basic
-
A thumbnail filter
Transformation — Class in namespace Imagine\Filter
-
A transformation filter
Transformation::thumbnail() — Method in class Transformation
-
Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image
Drawer::text() — Method in class Drawer
-
Annotates image with specified text at a given position starting on the top left of the final text box
Drawer::text() — Method in class Drawer
-
Annotates image with specified text at a given position starting on the top left of the final text box
AbstractImage::thumbnail() — Method in class AbstractImage
-
Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image
ManipulatorInterface::thumbnail() — Method in class ManipulatorInterface
-
Generates a thumbnail from a current image Returns it as a new image, doesn't modify the current image
MetadataBag::toArray() — Method in class MetadataBag
-
Returns metadata as an array
Drawer::text() — Method in class Drawer
-
Annotates image with specified text at a given position starting on the top left of the final text box
IsImageEqual::toString() — Method in class IsImageEqual
-
{@inheritdoc}

U

+
Annotates image with specified text at a given position starting on the top left of the final text box.
Thumbnail — Class in namespace Imagine\Filter\Basic
+
A thumbnail filter.
Transformation — Class in namespace Imagine\Filter
+
A transformation filter.
Transformation::thumbnail() — Method in class Transformation
+
Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.
Drawer::text() — Method in class Drawer
+
Annotates image with specified text at a given position starting on the top left of the final text box.
Drawer::text() — Method in class Drawer
+
Annotates image with specified text at a given position starting on the top left of the final text box.
AbstractImage::thumbnail() — Method in class AbstractImage
+
Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.
ManipulatorInterface::thumbnail() — Method in class ManipulatorInterface
+
Generates a thumbnail from a current image +Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.
MetadataBag::toArray() — Method in class MetadataBag
+
Returns metadata as an associative array.
Drawer::text() — Method in class Drawer
+
Annotates image with specified text at a given position starting on the top left of the final text box.
ErrorHandling::throwingRuntimeException() — Method in class ErrorHandling
+
Call a callback and throws a RuntimeException if a $flags warning is thrown.

U

Image::usePalette() — Method in class Image
-
Set a palette for the image.
Image::usePalette() — Method in class Image
-
Set a palette for the image.
ImageInterface::usePalette() — Method in class ImageInterface
-
Set a palette for the image.
CMYK::useProfile() — Method in class CMYK
+
Set a palette for the image. Useful to change colorspace.
Image::usePalette() — Method in class Image
+
Set a palette for the image. Useful to change colorspace.
AbstractImage::updateSaveOptions() — Method in class AbstractImage
+
Updates a given array of save options for backward compatibility with legacy names.
ImageInterface::usePalette() — Method in class ImageInterface
+
Set a palette for the image. Useful to change colorspace.
CMYK::useProfile() — Method in class CMYK
Attachs an ICC profile to this Palette.
Grayscale::useProfile() — Method in class Grayscale
Attachs an ICC profile to this Palette.
PaletteInterface::useProfile() — Method in class PaletteInterface
Attachs an ICC profile to this Palette.
RGB::useProfile() — Method in class RGB
Attachs an ICC profile to this Palette.
Image::usePalette() — Method in class Image
-
Set a palette for the image.

V

+
Set a palette for the image. Useful to change colorspace.

V

Layers::valid() — Method in class Layers
{@inheritdoc}
Layers::valid() — Method in class Layers
{@inheritdoc}
Vertical — Class in namespace Imagine\Image\Fill\Gradient
-
Vertical gradient fill
Layers::valid() — Method in class Layers
+
Vertical gradient fill.
Layers::valid() — Method in class Layers
{@inheritdoc}

W

WebOptimization — Class in namespace Imagine\Filter\Basic
-
A filter to render web-optimized images
Box::widen() — Method in class Box
-
Resizes box to given width, constraining proportions and returns the new box
BoxInterface::widen() — Method in class BoxInterface
-
Resizes box to given width, constraining proportions and returns the new box

_

-
Border::__construct() — Method in class Border
-
Constructs Border filter with given color, width and height
Canvas::__construct() — Method in class Canvas
-
Constructs Canvas filter with given width and height and the placement of the current image inside the new canvas
Grayscale::__construct() — Method in class Grayscale
-
-
OnPixelBased::__construct() — Method in class OnPixelBased
-
-
RelativeResize::__construct() — Method in class RelativeResize
+
A filter to render web-optimized images.
AbstractFont::wrapText() — Method in class AbstractFont
+
Split a string into multiple lines so that it fits a specific width.
Box::widen() — Method in class Box
+
Resizes box to given width, constraining proportions and returns the new box.
BoxInterface::widen() — Method in class BoxInterface
+
Resizes box to given width, constraining proportions and returns the new box.
FontInterface::wrapText() — Method in class FontInterface
+
Split a string into multiple lines so that it fits a specific width.
$Matrix#width — Property in class Matrix
+
The matrix width.

_

+
Loader::__construct() — Method in class Loader
+
Initialize the instance.
Loader::__toString() — Method in class Loader
+
The string representation of this object must be the file path (local or remote).
LoaderInterface::__toString() — Method in class LoaderInterface
+
The string representation of this object must be the file path (local or remote).
BlackWhite::__construct() — Method in class BlackWhite
+
Initialize this filter.
Border::__construct() — Method in class Border
+
Constructs Border filter with given color, width and height.
BorderDetection::__construct() — Method in class BorderDetection
+
Initialize this filter.
Canvas::__construct() — Method in class Canvas
+
Constructs Canvas filter with given width and height and the placement of the current image inside the new canvas.
Grayscale::__construct() — Method in class Grayscale
+
Initialize the instance.
Neighborhood::__construct() — Method in class Neighborhood
+
Initialize the instance.
OnPixelBased::__construct() — Method in class OnPixelBased
+
Initialize the instance.
RelativeResize::__construct() — Method in class RelativeResize
Constructs a RelativeResize filter with the given method and argument.
ApplyMask::__construct() — Method in class ApplyMask
-
-
Autorotate::__construct() — Method in class Autorotate
-
-
Crop::__construct() — Method in class Crop
-
Constructs a Crop filter with given x, y, coordinates and crop width and height values
Fill::__construct() — Method in class Fill
-
-
Paste::__construct() — Method in class Paste
-
Constructs a Paste filter with given ImageInterface to paste and x, y coordinates of target position
Resize::__construct() — Method in class Resize
-
Constructs Resize filter with given width and height
Rotate::__construct() — Method in class Rotate
-
Constructs Rotate filter with given angle and background color
Save::__construct() — Method in class Save
-
Constructs Save filter with given path and options
Show::__construct() — Method in class Show
-
Constructs the Show filter with given format and options
Thumbnail::__construct() — Method in class Thumbnail
-
Constructs the Thumbnail filter with given width, height and mode
WebOptimization::__construct() — Method in class WebOptimization
-
-
Transformation::__construct() — Method in class Transformation
+
Initialize the instance.
Autorotate::__construct() — Method in class Autorotate
+
Crop::__construct() — Method in class Crop
+
Constructs a Crop filter with given x, y, coordinates and crop width and height values.
Fill::__construct() — Method in class Fill
+
Paste::__construct() — Method in class Paste
+
Constructs a Paste filter with given ImageInterface to paste and x, y +coordinates of target position.
Resize::__construct() — Method in class Resize
+
Constructs Resize filter with given width and height.
Rotate::__construct() — Method in class Rotate
+
Constructs Rotate filter with given angle and background color.
Save::__construct() — Method in class Save
+
Constructs Save filter with given path and options.
Show::__construct() — Method in class Show
+
Constructs the Show filter with given format and options.
Thumbnail::__construct() — Method in class Thumbnail
+
Constructs the Thumbnail filter.
WebOptimization::__construct() — Method in class WebOptimization
+
Transformation::__construct() — Method in class Transformation
Class constructor.
Drawer::__construct() — Method in class Drawer
-
Constructs Drawer with a given gd image resource
Effects::__construct() — Method in class Effects
-
-
Image::__construct() — Method in class Image
-
Constructs a new Image instance
Image::__destruct() — Method in class Image
-
Makes sure the current image resource is destroyed
Image::__toString() — Method in class Image
-
Returns the image content as a PNG binary string
Imagine::__construct() — Method in class Imagine
-
-
Layers::__construct() — Method in class Layers
-
-
Drawer::__construct() — Method in class Drawer
-
-
Effects::__construct() — Method in class Effects
-
-
Font::__construct() — Method in class Font
-
-
Image::__construct() — Method in class Image
-
Constructs a new Image instance
Image::__destruct() — Method in class Image
-
Destroys allocated gmagick resources
Image::__toString() — Method in class Image
-
Returns the image content as a PNG binary string
Imagine::__construct() — Method in class Imagine
-
-
Layers::__construct() — Method in class Layers
-
-
AbstractFont::__construct() — Method in class AbstractFont
-
Constructs a font with specified $file, $size and $color
AbstractImage::__clone() — Method in class AbstractImage
-
Assures the metadata instance will be cloned, too
Box::__construct() — Method in class Box
-
Constructs the Size with given width and height
Box::__toString() — Method in class Box
-
Returns a string representation of the current box
BoxInterface::__toString() — Method in class BoxInterface
-
Returns a string representation of the current box
Linear::__construct() — Method in class Linear
-
Constructs a linear gradient with overall gradient length, and start and end shades, which default to 0 and 255 accordingly
Bucket::__construct() — Method in class Bucket
-
-
Range::__construct() — Method in class Range
-
-
ImageInterface::__toString() — Method in class ImageInterface
-
Returns the image content as a PNG binary string
ExifMetadataReader::__construct() — Method in class ExifMetadataReader
-
-
MetadataBag::__construct() — Method in class MetadataBag
-
-
CMYK::__construct() — Method in class CMYK
-
-
CMYK::__construct() — Method in class CMYK
-
-
CMYK::__toString() — Method in class CMYK
-
Returns hex representation of the color
Gray::__construct() — Method in class Gray
-
-
Gray::__toString() — Method in class Gray
-
Returns hex representation of the color
RGB::__construct() — Method in class RGB
-
-
RGB::__toString() — Method in class RGB
-
Returns hex representation of the color
Grayscale::__construct() — Method in class Grayscale
-
-
RGB::__construct() — Method in class RGB
-
-
Point::__construct() — Method in class Point
-
Constructs a point of coordinates
Point::__toString() — Method in class Point
-
Gets a string representation for the current point
PointInterface::__toString() — Method in class PointInterface
-
Gets a string representation for the current point
Center::__construct() — Method in class Center
-
Constructs coordinate with size instance, it needs to be relative to
Center::__toString() — Method in class Center
-
Gets a string representation for the current point
Profile::__construct() — Method in class Profile
-
-
Drawer::__construct() — Method in class Drawer
-
-
Effects::__construct() — Method in class Effects
-
-
Font::__construct() — Method in class Font
-
-
Image::__construct() — Method in class Image
-
Constructs a new Image instance
Image::__destruct() — Method in class Image
-
Destroys allocated imagick resources
Image::__toString() — Method in class Image
-
Returns the image content as a PNG binary string
Imagine::__construct() — Method in class Imagine
-
-
Layers::__construct() — Method in class Layers
-
-
IsImageEqual::__construct() — Method in class IsImageEqual
-
-
- + + +
+ diff --git a/docs/API/API/fonts/glyphicons-halflings-regular.eot b/docs/API/API/fonts/glyphicons-halflings-regular.eot new file mode 100644 index 000000000..4a4ca865d Binary files /dev/null and b/docs/API/API/fonts/glyphicons-halflings-regular.eot differ diff --git a/docs/API/API/fonts/glyphicons-halflings-regular.svg b/docs/API/API/fonts/glyphicons-halflings-regular.svg new file mode 100644 index 000000000..25691af8f --- /dev/null +++ b/docs/API/API/fonts/glyphicons-halflings-regular.svg @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/API/API/fonts/glyphicons-halflings-regular.ttf b/docs/API/API/fonts/glyphicons-halflings-regular.ttf new file mode 100644 index 000000000..67fa00bf8 Binary files /dev/null and b/docs/API/API/fonts/glyphicons-halflings-regular.ttf differ diff --git a/docs/API/API/fonts/glyphicons-halflings-regular.woff b/docs/API/API/fonts/glyphicons-halflings-regular.woff new file mode 100644 index 000000000..8c54182aa Binary files /dev/null and b/docs/API/API/fonts/glyphicons-halflings-regular.woff differ diff --git a/docs/API/API/i/arrows.png b/docs/API/API/i/arrows.png deleted file mode 100644 index e54060f44..000000000 Binary files a/docs/API/API/i/arrows.png and /dev/null differ diff --git a/docs/API/API/i/loader.gif b/docs/API/API/i/loader.gif deleted file mode 100644 index e2a116c72..000000000 Binary files a/docs/API/API/i/loader.gif and /dev/null differ diff --git a/docs/API/API/i/results_bg.png b/docs/API/API/i/results_bg.png deleted file mode 100644 index 199ba6923..000000000 Binary files a/docs/API/API/i/results_bg.png and /dev/null differ diff --git a/docs/API/API/i/tree_bg.png b/docs/API/API/i/tree_bg.png deleted file mode 100644 index 7d236633d..000000000 Binary files a/docs/API/API/i/tree_bg.png and /dev/null differ diff --git a/docs/API/API/index.html b/docs/API/API/index.html index a30923200..b8e705d57 100644 --- a/docs/API/API/index.html +++ b/docs/API/API/index.html @@ -1,21 +1,109 @@ - - - - - - - - - - - - - - <body> - Your browser does not support frames. Go to the <a href="http://github.com/namespaces.html">non-frame version</a>. - </body> - - + + + + Namespaces | Imagine API v1.2.5-dev + + + + + + + + + + + + + + + + +
+
+
+ +
+ + +
+
+ +
+ +
+ +
+ + diff --git a/docs/API/API/interfaces.html b/docs/API/API/interfaces.html index 0e402222c..3fd623805 100644 --- a/docs/API/API/interfaces.html +++ b/docs/API/API/interfaces.html @@ -1,132 +1,254 @@ - - - - Interfaces | - - - -
- + + + + Interfaces | Imagine API v1.2.5-dev -
+ + + + + + + + + + + + + -

Interfaces

+ +
+
+
+ +
+ + +
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Imagine\Draw\DrawerInterface - Interface for the drawer -
Imagine\Effects\EffectsInterface - Interface for the effects -
Imagine\Exception\Exception - Imagine-specific exception -
Imagine\Filter\FilterInterface - Interface for imagine filters -
Imagine\Image\BoxInterface - Interface for a box -
Imagine\Image\Fill\FillInterface - Interface for the fill -
Imagine\Image\FontInterface - The font interface -
Imagine\Image\ImageInterface - The image interface -
Imagine\Image\ImagineInterface - The imagine interface -
Imagine\Image\LayersInterface - The layers interface -
Imagine\Image\ManipulatorInterface - The manipulator interface -
Imagine\Image\Metadata\MetadataReaderInterface - -
Imagine\Image\Palette\Color\ColorInterface - +
-
Imagine\Image\Palette\PaletteInterface - + +
+ -
Imagine\Image\PointInterface - The point interface -
Imagine\Image\ProfileInterface +
+
+

Interfaces

+
+ + +
+
+
+ DrawerInterface + +
+
+ Interface for the drawer. +
+
+
+
+ EffectsInterface + +
+
+ Interface for the effects. +
+
+
+
+ Exception + +
+
+ Imagine-specific exception. +
+
+
+
+ ClassFactoryAwareInterface + +
+
+ An interface that classes that accepts a class factory should implement. +
+
+
+
+ ClassFactoryInterface + +
+
+ The interface that class factories must implement. +
+
+
+
+ LoaderInterface + +
+
+ Interface for classes that can load local or remote files. +
+
+
+
+ FilterInterface + +
+
+ Interface for imagine filters. +
+
+
+
+ BoxInterface + +
+
+ Interface for a box. +
+
+
+
+ FillInterface + +
+
+ Interface for the fill. +
+
+
+
+ FontInterface + +
+
+ The font interface. +
+
+
+
+ ImageInterface + +
+
+ The image interface. +
+
+
+
+ ImagineInterface + +
+
+ The imagine interface. +
+
+
+
+ LayersInterface + +
+
+ The layers interface. +
+
+
+
+ ManipulatorInterface + +
+
+ The manipulator interface. +
+
+
+
+ MetadataReaderInterface + +
+
+ Interface that metadata readers must implement. +
+
+
+
+ ColorInterface + +
+
+ +
+
+
+
+ PaletteInterface + +
+
+ Interface that any palette must implement. +
+
+
+
+ PointInterface + +
+
+ The point interface. +
+
+
+
+ ProfileInterface + +
+
+
+
+
+
+ -
- + diff --git a/docs/API/API/js/bootstrap.min.js b/docs/API/API/js/bootstrap.min.js new file mode 100755 index 000000000..051dd94fd --- /dev/null +++ b/docs/API/API/js/bootstrap.min.js @@ -0,0 +1,12 @@ +/*! + * Bootstrap v3.3.1 (http://getbootstrap.com) + * Copyright 2011-2014 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + */ + +/*! + * Generated using the Bootstrap Customizer (http://getbootstrap.com/customize/?id=cb5a84c449e8302c563e) + * Config saved to config.json and https://gist.github.com/cb5a84c449e8302c563e + */ +if("undefined"==typeof jQuery)throw new Error("Bootstrap's JavaScript requires jQuery");+function(t){var e=t.fn.jquery.split(" ")[0].split(".");if(e[0]<2&&e[1]<9||1==e[0]&&9==e[1]&&e[2]<1)throw new Error("Bootstrap's JavaScript requires jQuery version 1.9.1 or higher")}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var i=t(this),s=i.data("bs.alert");s||i.data("bs.alert",s=new o(this)),"string"==typeof e&&s[e].call(i)})}var i='[data-dismiss="alert"]',o=function(e){t(e).on("click",i,this.close)};o.VERSION="3.3.1",o.TRANSITION_DURATION=150,o.prototype.close=function(e){function i(){a.detach().trigger("closed.bs.alert").remove()}var s=t(this),n=s.attr("data-target");n||(n=s.attr("href"),n=n&&n.replace(/.*(?=#[^\s]*$)/,""));var a=t(n);e&&e.preventDefault(),a.length||(a=s.closest(".alert")),a.trigger(e=t.Event("close.bs.alert")),e.isDefaultPrevented()||(a.removeClass("in"),t.support.transition&&a.hasClass("fade")?a.one("bsTransitionEnd",i).emulateTransitionEnd(o.TRANSITION_DURATION):i())};var s=t.fn.alert;t.fn.alert=e,t.fn.alert.Constructor=o,t.fn.alert.noConflict=function(){return t.fn.alert=s,this},t(document).on("click.bs.alert.data-api",i,o.prototype.close)}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.button"),n="object"==typeof e&&e;s||o.data("bs.button",s=new i(this,n)),"toggle"==e?s.toggle():e&&s.setState(e)})}var i=function(e,o){this.$element=t(e),this.options=t.extend({},i.DEFAULTS,o),this.isLoading=!1};i.VERSION="3.3.1",i.DEFAULTS={loadingText:"loading..."},i.prototype.setState=function(e){var i="disabled",o=this.$element,s=o.is("input")?"val":"html",n=o.data();e+="Text",null==n.resetText&&o.data("resetText",o[s]()),setTimeout(t.proxy(function(){o[s](null==n[e]?this.options[e]:n[e]),"loadingText"==e?(this.isLoading=!0,o.addClass(i).attr(i,i)):this.isLoading&&(this.isLoading=!1,o.removeClass(i).removeAttr(i))},this),0)},i.prototype.toggle=function(){var t=!0,e=this.$element.closest('[data-toggle="buttons"]');if(e.length){var i=this.$element.find("input");"radio"==i.prop("type")&&(i.prop("checked")&&this.$element.hasClass("active")?t=!1:e.find(".active").removeClass("active")),t&&i.prop("checked",!this.$element.hasClass("active")).trigger("change")}else this.$element.attr("aria-pressed",!this.$element.hasClass("active"));t&&this.$element.toggleClass("active")};var o=t.fn.button;t.fn.button=e,t.fn.button.Constructor=i,t.fn.button.noConflict=function(){return t.fn.button=o,this},t(document).on("click.bs.button.data-api",'[data-toggle^="button"]',function(i){var o=t(i.target);o.hasClass("btn")||(o=o.closest(".btn")),e.call(o,"toggle"),i.preventDefault()}).on("focus.bs.button.data-api blur.bs.button.data-api",'[data-toggle^="button"]',function(e){t(e.target).closest(".btn").toggleClass("focus",/^focus(in)?$/.test(e.type))})}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.carousel"),n=t.extend({},i.DEFAULTS,o.data(),"object"==typeof e&&e),a="string"==typeof e?e:n.slide;s||o.data("bs.carousel",s=new i(this,n)),"number"==typeof e?s.to(e):a?s[a]():n.interval&&s.pause().cycle()})}var i=function(e,i){this.$element=t(e),this.$indicators=this.$element.find(".carousel-indicators"),this.options=i,this.paused=this.sliding=this.interval=this.$active=this.$items=null,this.options.keyboard&&this.$element.on("keydown.bs.carousel",t.proxy(this.keydown,this)),"hover"==this.options.pause&&!("ontouchstart"in document.documentElement)&&this.$element.on("mouseenter.bs.carousel",t.proxy(this.pause,this)).on("mouseleave.bs.carousel",t.proxy(this.cycle,this))};i.VERSION="3.3.1",i.TRANSITION_DURATION=600,i.DEFAULTS={interval:5e3,pause:"hover",wrap:!0,keyboard:!0},i.prototype.keydown=function(t){if(!/input|textarea/i.test(t.target.tagName)){switch(t.which){case 37:this.prev();break;case 39:this.next();break;default:return}t.preventDefault()}},i.prototype.cycle=function(e){return e||(this.paused=!1),this.interval&&clearInterval(this.interval),this.options.interval&&!this.paused&&(this.interval=setInterval(t.proxy(this.next,this),this.options.interval)),this},i.prototype.getItemIndex=function(t){return this.$items=t.parent().children(".item"),this.$items.index(t||this.$active)},i.prototype.getItemForDirection=function(t,e){var i="prev"==t?-1:1,o=this.getItemIndex(e),s=(o+i)%this.$items.length;return this.$items.eq(s)},i.prototype.to=function(t){var e=this,i=this.getItemIndex(this.$active=this.$element.find(".item.active"));return t>this.$items.length-1||0>t?void 0:this.sliding?this.$element.one("slid.bs.carousel",function(){e.to(t)}):i==t?this.pause().cycle():this.slide(t>i?"next":"prev",this.$items.eq(t))},i.prototype.pause=function(e){return e||(this.paused=!0),this.$element.find(".next, .prev").length&&t.support.transition&&(this.$element.trigger(t.support.transition.end),this.cycle(!0)),this.interval=clearInterval(this.interval),this},i.prototype.next=function(){return this.sliding?void 0:this.slide("next")},i.prototype.prev=function(){return this.sliding?void 0:this.slide("prev")},i.prototype.slide=function(e,o){var s=this.$element.find(".item.active"),n=o||this.getItemForDirection(e,s),a=this.interval,r="next"==e?"left":"right",l="next"==e?"first":"last",h=this;if(!n.length){if(!this.options.wrap)return;n=this.$element.find(".item")[l]()}if(n.hasClass("active"))return this.sliding=!1;var d=n[0],p=t.Event("slide.bs.carousel",{relatedTarget:d,direction:r});if(this.$element.trigger(p),!p.isDefaultPrevented()){if(this.sliding=!0,a&&this.pause(),this.$indicators.length){this.$indicators.find(".active").removeClass("active");var c=t(this.$indicators.children()[this.getItemIndex(n)]);c&&c.addClass("active")}var f=t.Event("slid.bs.carousel",{relatedTarget:d,direction:r});return t.support.transition&&this.$element.hasClass("slide")?(n.addClass(e),n[0].offsetWidth,s.addClass(r),n.addClass(r),s.one("bsTransitionEnd",function(){n.removeClass([e,r].join(" ")).addClass("active"),s.removeClass(["active",r].join(" ")),h.sliding=!1,setTimeout(function(){h.$element.trigger(f)},0)}).emulateTransitionEnd(i.TRANSITION_DURATION)):(s.removeClass("active"),n.addClass("active"),this.sliding=!1,this.$element.trigger(f)),a&&this.cycle(),this}};var o=t.fn.carousel;t.fn.carousel=e,t.fn.carousel.Constructor=i,t.fn.carousel.noConflict=function(){return t.fn.carousel=o,this};var s=function(i){var o,s=t(this),n=t(s.attr("data-target")||(o=s.attr("href"))&&o.replace(/.*(?=#[^\s]+$)/,""));if(n.hasClass("carousel")){var a=t.extend({},n.data(),s.data()),r=s.attr("data-slide-to");r&&(a.interval=!1),e.call(n,a),r&&n.data("bs.carousel").to(r),i.preventDefault()}};t(document).on("click.bs.carousel.data-api","[data-slide]",s).on("click.bs.carousel.data-api","[data-slide-to]",s),t(window).on("load",function(){t('[data-ride="carousel"]').each(function(){var i=t(this);e.call(i,i.data())})})}(jQuery),+function(t){"use strict";function e(e){e&&3===e.which||(t(s).remove(),t(n).each(function(){var o=t(this),s=i(o),n={relatedTarget:this};s.hasClass("open")&&(s.trigger(e=t.Event("hide.bs.dropdown",n)),e.isDefaultPrevented()||(o.attr("aria-expanded","false"),s.removeClass("open").trigger("hidden.bs.dropdown",n)))}))}function i(e){var i=e.attr("data-target");i||(i=e.attr("href"),i=i&&/#[A-Za-z]/.test(i)&&i.replace(/.*(?=#[^\s]*$)/,""));var o=i&&t(i);return o&&o.length?o:e.parent()}function o(e){return this.each(function(){var i=t(this),o=i.data("bs.dropdown");o||i.data("bs.dropdown",o=new a(this)),"string"==typeof e&&o[e].call(i)})}var s=".dropdown-backdrop",n='[data-toggle="dropdown"]',a=function(e){t(e).on("click.bs.dropdown",this.toggle)};a.VERSION="3.3.1",a.prototype.toggle=function(o){var s=t(this);if(!s.is(".disabled, :disabled")){var n=i(s),a=n.hasClass("open");if(e(),!a){"ontouchstart"in document.documentElement&&!n.closest(".navbar-nav").length&&t('
').insertAfter(t(this)).on("click",e);var r={relatedTarget:this};if(n.trigger(o=t.Event("show.bs.dropdown",r)),o.isDefaultPrevented())return;s.trigger("focus").attr("aria-expanded","true"),n.toggleClass("open").trigger("shown.bs.dropdown",r)}return!1}},a.prototype.keydown=function(e){if(/(38|40|27|32)/.test(e.which)&&!/input|textarea/i.test(e.target.tagName)){var o=t(this);if(e.preventDefault(),e.stopPropagation(),!o.is(".disabled, :disabled")){var s=i(o),a=s.hasClass("open");if(!a&&27!=e.which||a&&27==e.which)return 27==e.which&&s.find(n).trigger("focus"),o.trigger("click");var r=" li:not(.divider):visible a",l=s.find('[role="menu"]'+r+', [role="listbox"]'+r);if(l.length){var h=l.index(e.target);38==e.which&&h>0&&h--,40==e.which&&h').prependTo(this.$element).on("click.dismiss.bs.modal",t.proxy(function(t){t.target===t.currentTarget&&("static"==this.options.backdrop?this.$element[0].focus.call(this.$element[0]):this.hide.call(this))},this)),n&&this.$backdrop[0].offsetWidth,this.$backdrop.addClass("in"),!e)return;n?this.$backdrop.one("bsTransitionEnd",e).emulateTransitionEnd(i.BACKDROP_TRANSITION_DURATION):e()}else if(!this.isShown&&this.$backdrop){this.$backdrop.removeClass("in");var a=function(){o.removeBackdrop(),e&&e()};t.support.transition&&this.$element.hasClass("fade")?this.$backdrop.one("bsTransitionEnd",a).emulateTransitionEnd(i.BACKDROP_TRANSITION_DURATION):a()}else e&&e()},i.prototype.handleUpdate=function(){this.options.backdrop&&this.adjustBackdrop(),this.adjustDialog()},i.prototype.adjustBackdrop=function(){this.$backdrop.css("height",0).css("height",this.$element[0].scrollHeight)},i.prototype.adjustDialog=function(){var t=this.$element[0].scrollHeight>document.documentElement.clientHeight;this.$element.css({paddingLeft:!this.bodyIsOverflowing&&t?this.scrollbarWidth:"",paddingRight:this.bodyIsOverflowing&&!t?this.scrollbarWidth:""})},i.prototype.resetAdjustments=function(){this.$element.css({paddingLeft:"",paddingRight:""})},i.prototype.checkScrollbar=function(){this.bodyIsOverflowing=document.body.scrollHeight>document.documentElement.clientHeight,this.scrollbarWidth=this.measureScrollbar()},i.prototype.setScrollbar=function(){var t=parseInt(this.$body.css("padding-right")||0,10);this.bodyIsOverflowing&&this.$body.css("padding-right",t+this.scrollbarWidth)},i.prototype.resetScrollbar=function(){this.$body.css("padding-right","")},i.prototype.measureScrollbar=function(){var t=document.createElement("div");t.className="modal-scrollbar-measure",this.$body.append(t);var e=t.offsetWidth-t.clientWidth;return this.$body[0].removeChild(t),e};var o=t.fn.modal;t.fn.modal=e,t.fn.modal.Constructor=i,t.fn.modal.noConflict=function(){return t.fn.modal=o,this},t(document).on("click.bs.modal.data-api",'[data-toggle="modal"]',function(i){var o=t(this),s=o.attr("href"),n=t(o.attr("data-target")||s&&s.replace(/.*(?=#[^\s]+$)/,"")),a=n.data("bs.modal")?"toggle":t.extend({remote:!/#/.test(s)&&s},n.data(),o.data());o.is("a")&&i.preventDefault(),n.one("show.bs.modal",function(t){t.isDefaultPrevented()||n.one("hidden.bs.modal",function(){o.is(":visible")&&o.trigger("focus")})}),e.call(n,a,this)})}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.tooltip"),n="object"==typeof e&&e,a=n&&n.selector;(s||"destroy"!=e)&&(a?(s||o.data("bs.tooltip",s={}),s[a]||(s[a]=new i(this,n))):s||o.data("bs.tooltip",s=new i(this,n)),"string"==typeof e&&s[e]())})}var i=function(t,e){this.type=this.options=this.enabled=this.timeout=this.hoverState=this.$element=null,this.init("tooltip",t,e)};i.VERSION="3.3.1",i.TRANSITION_DURATION=150,i.DEFAULTS={animation:!0,placement:"top",selector:!1,template:'',trigger:"hover focus",title:"",delay:0,html:!1,container:!1,viewport:{selector:"body",padding:0}},i.prototype.init=function(e,i,o){this.enabled=!0,this.type=e,this.$element=t(i),this.options=this.getOptions(o),this.$viewport=this.options.viewport&&t(this.options.viewport.selector||this.options.viewport);for(var s=this.options.trigger.split(" "),n=s.length;n--;){var a=s[n];if("click"==a)this.$element.on("click."+this.type,this.options.selector,t.proxy(this.toggle,this));else if("manual"!=a){var r="hover"==a?"mouseenter":"focusin",l="hover"==a?"mouseleave":"focusout";this.$element.on(r+"."+this.type,this.options.selector,t.proxy(this.enter,this)),this.$element.on(l+"."+this.type,this.options.selector,t.proxy(this.leave,this))}}this.options.selector?this._options=t.extend({},this.options,{trigger:"manual",selector:""}):this.fixTitle()},i.prototype.getDefaults=function(){return i.DEFAULTS},i.prototype.getOptions=function(e){return e=t.extend({},this.getDefaults(),this.$element.data(),e),e.delay&&"number"==typeof e.delay&&(e.delay={show:e.delay,hide:e.delay}),e},i.prototype.getDelegateOptions=function(){var e={},i=this.getDefaults();return this._options&&t.each(this._options,function(t,o){i[t]!=o&&(e[t]=o)}),e},i.prototype.enter=function(e){var i=e instanceof this.constructor?e:t(e.currentTarget).data("bs."+this.type);return i&&i.$tip&&i.$tip.is(":visible")?void(i.hoverState="in"):(i||(i=new this.constructor(e.currentTarget,this.getDelegateOptions()),t(e.currentTarget).data("bs."+this.type,i)),clearTimeout(i.timeout),i.hoverState="in",i.options.delay&&i.options.delay.show?void(i.timeout=setTimeout(function(){"in"==i.hoverState&&i.show()},i.options.delay.show)):i.show())},i.prototype.leave=function(e){var i=e instanceof this.constructor?e:t(e.currentTarget).data("bs."+this.type);return i||(i=new this.constructor(e.currentTarget,this.getDelegateOptions()),t(e.currentTarget).data("bs."+this.type,i)),clearTimeout(i.timeout),i.hoverState="out",i.options.delay&&i.options.delay.hide?void(i.timeout=setTimeout(function(){"out"==i.hoverState&&i.hide()},i.options.delay.hide)):i.hide()},i.prototype.show=function(){var e=t.Event("show.bs."+this.type);if(this.hasContent()&&this.enabled){this.$element.trigger(e);var o=t.contains(this.$element[0].ownerDocument.documentElement,this.$element[0]);if(e.isDefaultPrevented()||!o)return;var s=this,n=this.tip(),a=this.getUID(this.type);this.setContent(),n.attr("id",a),this.$element.attr("aria-describedby",a),this.options.animation&&n.addClass("fade");var r="function"==typeof this.options.placement?this.options.placement.call(this,n[0],this.$element[0]):this.options.placement,l=/\s?auto?\s?/i,h=l.test(r);h&&(r=r.replace(l,"")||"top"),n.detach().css({top:0,left:0,display:"block"}).addClass(r).data("bs."+this.type,this),this.options.container?n.appendTo(this.options.container):n.insertAfter(this.$element);var d=this.getPosition(),p=n[0].offsetWidth,c=n[0].offsetHeight;if(h){var f=r,u=this.options.container?t(this.options.container):this.$element.parent(),g=this.getPosition(u);r="bottom"==r&&d.bottom+c>g.bottom?"top":"top"==r&&d.top-cg.width?"left":"left"==r&&d.left-pa.top+a.height&&(s.top=a.top+a.height-l)}else{var h=e.left-n,d=e.left+n+i;ha.width&&(s.left=a.left+a.width-d)}return s},i.prototype.getTitle=function(){var t,e=this.$element,i=this.options;return t=e.attr("data-original-title")||("function"==typeof i.title?i.title.call(e[0]):i.title)},i.prototype.getUID=function(t){do t+=~~(1e6*Math.random());while(document.getElementById(t));return t},i.prototype.tip=function(){return this.$tip=this.$tip||t(this.options.template)},i.prototype.arrow=function(){return this.$arrow=this.$arrow||this.tip().find(".tooltip-arrow")},i.prototype.enable=function(){this.enabled=!0},i.prototype.disable=function(){this.enabled=!1},i.prototype.toggleEnabled=function(){this.enabled=!this.enabled},i.prototype.toggle=function(e){var i=this;e&&(i=t(e.currentTarget).data("bs."+this.type),i||(i=new this.constructor(e.currentTarget,this.getDelegateOptions()),t(e.currentTarget).data("bs."+this.type,i))),i.tip().hasClass("in")?i.leave(i):i.enter(i)},i.prototype.destroy=function(){var t=this;clearTimeout(this.timeout),this.hide(function(){t.$element.off("."+t.type).removeData("bs."+t.type)})};var o=t.fn.tooltip;t.fn.tooltip=e,t.fn.tooltip.Constructor=i,t.fn.tooltip.noConflict=function(){return t.fn.tooltip=o,this}}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.popover"),n="object"==typeof e&&e,a=n&&n.selector;(s||"destroy"!=e)&&(a?(s||o.data("bs.popover",s={}),s[a]||(s[a]=new i(this,n))):s||o.data("bs.popover",s=new i(this,n)),"string"==typeof e&&s[e]())})}var i=function(t,e){this.init("popover",t,e)};if(!t.fn.tooltip)throw new Error("Popover requires tooltip.js");i.VERSION="3.3.1",i.DEFAULTS=t.extend({},t.fn.tooltip.Constructor.DEFAULTS,{placement:"right",trigger:"click",content:"",template:''}),i.prototype=t.extend({},t.fn.tooltip.Constructor.prototype),i.prototype.constructor=i,i.prototype.getDefaults=function(){return i.DEFAULTS},i.prototype.setContent=function(){var t=this.tip(),e=this.getTitle(),i=this.getContent();t.find(".popover-title")[this.options.html?"html":"text"](e),t.find(".popover-content").children().detach().end()[this.options.html?"string"==typeof i?"html":"append":"text"](i),t.removeClass("fade top bottom left right in"),t.find(".popover-title").html()||t.find(".popover-title").hide()},i.prototype.hasContent=function(){return this.getTitle()||this.getContent()},i.prototype.getContent=function(){var t=this.$element,e=this.options;return t.attr("data-content")||("function"==typeof e.content?e.content.call(t[0]):e.content)},i.prototype.arrow=function(){return this.$arrow=this.$arrow||this.tip().find(".arrow")},i.prototype.tip=function(){return this.$tip||(this.$tip=t(this.options.template)),this.$tip};var o=t.fn.popover;t.fn.popover=e,t.fn.popover.Constructor=i,t.fn.popover.noConflict=function(){return t.fn.popover=o,this}}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.tab");s||o.data("bs.tab",s=new i(this)),"string"==typeof e&&s[e]()})}var i=function(e){this.element=t(e)};i.VERSION="3.3.1",i.TRANSITION_DURATION=150,i.prototype.show=function(){var e=this.element,i=e.closest("ul:not(.dropdown-menu)"),o=e.data("target");if(o||(o=e.attr("href"),o=o&&o.replace(/.*(?=#[^\s]*$)/,"")),!e.parent("li").hasClass("active")){var s=i.find(".active:last a"),n=t.Event("hide.bs.tab",{relatedTarget:e[0]}),a=t.Event("show.bs.tab",{relatedTarget:s[0]});if(s.trigger(n),e.trigger(a),!a.isDefaultPrevented()&&!n.isDefaultPrevented()){var r=t(o);this.activate(e.closest("li"),i),this.activate(r,r.parent(),function(){s.trigger({type:"hidden.bs.tab",relatedTarget:e[0]}),e.trigger({type:"shown.bs.tab",relatedTarget:s[0]})})}}},i.prototype.activate=function(e,o,s){function n(){a.removeClass("active").find("> .dropdown-menu > .active").removeClass("active").end().find('[data-toggle="tab"]').attr("aria-expanded",!1),e.addClass("active").find('[data-toggle="tab"]').attr("aria-expanded",!0),r?(e[0].offsetWidth,e.addClass("in")):e.removeClass("fade"),e.parent(".dropdown-menu")&&e.closest("li.dropdown").addClass("active").end().find('[data-toggle="tab"]').attr("aria-expanded",!0),s&&s()}var a=o.find("> .active"),r=s&&t.support.transition&&(a.length&&a.hasClass("fade")||!!o.find("> .fade").length);a.length&&r?a.one("bsTransitionEnd",n).emulateTransitionEnd(i.TRANSITION_DURATION):n(),a.removeClass("in")};var o=t.fn.tab;t.fn.tab=e,t.fn.tab.Constructor=i,t.fn.tab.noConflict=function(){return t.fn.tab=o,this};var s=function(i){i.preventDefault(),e.call(t(this),"show")};t(document).on("click.bs.tab.data-api",'[data-toggle="tab"]',s).on("click.bs.tab.data-api",'[data-toggle="pill"]',s)}(jQuery),+function(t){"use strict";function e(e){return this.each(function(){var o=t(this),s=o.data("bs.affix"),n="object"==typeof e&&e;s||o.data("bs.affix",s=new i(this,n)),"string"==typeof e&&s[e]()})}var i=function(e,o){this.options=t.extend({},i.DEFAULTS,o),this.$target=t(this.options.target).on("scroll.bs.affix.data-api",t.proxy(this.checkPosition,this)).on("click.bs.affix.data-api",t.proxy(this.checkPositionWithEventLoop,this)),this.$element=t(e),this.affixed=this.unpin=this.pinnedOffset=null,this.checkPosition()};i.VERSION="3.3.1",i.RESET="affix affix-top affix-bottom",i.DEFAULTS={offset:0,target:window},i.prototype.getState=function(t,e,i,o){var s=this.$target.scrollTop(),n=this.$element.offset(),a=this.$target.height();if(null!=i&&"top"==this.affixed)return i>s?"top":!1;if("bottom"==this.affixed)return null!=i?s+this.unpin<=n.top?!1:"bottom":t-o>=s+a?!1:"bottom";var r=null==this.affixed,l=r?s:n.top,h=r?a:e;return null!=i&&i>=l?"top":null!=o&&l+h>=t-o?"bottom":!1},i.prototype.getPinnedOffset=function(){if(this.pinnedOffset)return this.pinnedOffset;this.$element.removeClass(i.RESET).addClass("affix");var t=this.$target.scrollTop(),e=this.$element.offset();return this.pinnedOffset=e.top-t},i.prototype.checkPositionWithEventLoop=function(){setTimeout(t.proxy(this.checkPosition,this),1)},i.prototype.checkPosition=function(){if(this.$element.is(":visible")){var e=this.$element.height(),o=this.options.offset,s=o.top,n=o.bottom,a=t("body").height();"object"!=typeof o&&(n=s=o),"function"==typeof s&&(s=o.top(this.$element)),"function"==typeof n&&(n=o.bottom(this.$element));var r=this.getState(a,e,s,n);if(this.affixed!=r){null!=this.unpin&&this.$element.css("top","");var l="affix"+(r?"-"+r:""),h=t.Event(l+".bs.affix");if(this.$element.trigger(h),h.isDefaultPrevented())return;this.affixed=r,this.unpin="bottom"==r?this.getPinnedOffset():null,this.$element.removeClass(i.RESET).addClass(l).trigger(l.replace("affix","affixed")+".bs.affix")}"bottom"==r&&this.$element.offset({top:a-e-n})}};var o=t.fn.affix;t.fn.affix=e,t.fn.affix.Constructor=i,t.fn.affix.noConflict=function(){return t.fn.affix=o,this},t(window).on("load",function(){t('[data-spy="affix"]').each(function(){var i=t(this),o=i.data();o.offset=o.offset||{},null!=o.offsetBottom&&(o.offset.bottom=o.offsetBottom),null!=o.offsetTop&&(o.offset.top=o.offsetTop),e.call(i,o)})})}(jQuery),+function(t){"use strict";function e(e){var i,o=e.attr("data-target")||(i=e.attr("href"))&&i.replace(/.*(?=#[^\s]+$)/,"");return t(o)}function i(e){return this.each(function(){var i=t(this),s=i.data("bs.collapse"),n=t.extend({},o.DEFAULTS,i.data(),"object"==typeof e&&e);!s&&n.toggle&&"show"==e&&(n.toggle=!1),s||i.data("bs.collapse",s=new o(this,n)),"string"==typeof e&&s[e]()})}var o=function(e,i){this.$element=t(e),this.options=t.extend({},o.DEFAULTS,i),this.$trigger=t(this.options.trigger).filter('[href="#'+e.id+'"], [data-target="#'+e.id+'"]'),this.transitioning=null,this.options.parent?this.$parent=this.getParent():this.addAriaAndCollapsedClass(this.$element,this.$trigger),this.options.toggle&&this.toggle()};o.VERSION="3.3.1",o.TRANSITION_DURATION=350,o.DEFAULTS={toggle:!0,trigger:'[data-toggle="collapse"]'},o.prototype.dimension=function(){var t=this.$element.hasClass("width");return t?"width":"height"},o.prototype.show=function(){if(!this.transitioning&&!this.$element.hasClass("in")){var e,s=this.$parent&&this.$parent.find("> .panel").children(".in, .collapsing");if(!(s&&s.length&&(e=s.data("bs.collapse"),e&&e.transitioning))){var n=t.Event("show.bs.collapse");if(this.$element.trigger(n),!n.isDefaultPrevented()){s&&s.length&&(i.call(s,"hide"),e||s.data("bs.collapse",null));var a=this.dimension();this.$element.removeClass("collapse").addClass("collapsing")[a](0).attr("aria-expanded",!0),this.$trigger.removeClass("collapsed").attr("aria-expanded",!0),this.transitioning=1;var r=function(){this.$element.removeClass("collapsing").addClass("collapse in")[a](""),this.transitioning=0,this.$element.trigger("shown.bs.collapse")};if(!t.support.transition)return r.call(this);var l=t.camelCase(["scroll",a].join("-"));this.$element.one("bsTransitionEnd",t.proxy(r,this)).emulateTransitionEnd(o.TRANSITION_DURATION)[a](this.$element[0][l])}}}},o.prototype.hide=function(){if(!this.transitioning&&this.$element.hasClass("in")){var e=t.Event("hide.bs.collapse");if(this.$element.trigger(e),!e.isDefaultPrevented()){var i=this.dimension();this.$element[i](this.$element[i]())[0].offsetHeight,this.$element.addClass("collapsing").removeClass("collapse in").attr("aria-expanded",!1),this.$trigger.addClass("collapsed").attr("aria-expanded",!1),this.transitioning=1;var s=function(){this.transitioning=0,this.$element.removeClass("collapsing").addClass("collapse").trigger("hidden.bs.collapse")};return t.support.transition?void this.$element[i](0).one("bsTransitionEnd",t.proxy(s,this)).emulateTransitionEnd(o.TRANSITION_DURATION):s.call(this)}}},o.prototype.toggle=function(){this[this.$element.hasClass("in")?"hide":"show"]()},o.prototype.getParent=function(){return t(this.options.parent).find('[data-toggle="collapse"][data-parent="'+this.options.parent+'"]').each(t.proxy(function(i,o){var s=t(o);this.addAriaAndCollapsedClass(e(s),s)},this)).end()},o.prototype.addAriaAndCollapsedClass=function(t,e){var i=t.hasClass("in");t.attr("aria-expanded",i),e.toggleClass("collapsed",!i).attr("aria-expanded",i)};var s=t.fn.collapse;t.fn.collapse=i,t.fn.collapse.Constructor=o,t.fn.collapse.noConflict=function(){return t.fn.collapse=s,this +},t(document).on("click.bs.collapse.data-api",'[data-toggle="collapse"]',function(o){var s=t(this);s.attr("data-target")||o.preventDefault();var n=e(s),a=n.data("bs.collapse"),r=a?"toggle":t.extend({},s.data(),{trigger:this});i.call(n,r)})}(jQuery),+function(t){"use strict";function e(i,o){var s=t.proxy(this.process,this);this.$body=t("body"),this.$scrollElement=t(t(i).is("body")?window:i),this.options=t.extend({},e.DEFAULTS,o),this.selector=(this.options.target||"")+" .nav li > a",this.offsets=[],this.targets=[],this.activeTarget=null,this.scrollHeight=0,this.$scrollElement.on("scroll.bs.scrollspy",s),this.refresh(),this.process()}function i(i){return this.each(function(){var o=t(this),s=o.data("bs.scrollspy"),n="object"==typeof i&&i;s||o.data("bs.scrollspy",s=new e(this,n)),"string"==typeof i&&s[i]()})}e.VERSION="3.3.1",e.DEFAULTS={offset:10},e.prototype.getScrollHeight=function(){return this.$scrollElement[0].scrollHeight||Math.max(this.$body[0].scrollHeight,document.documentElement.scrollHeight)},e.prototype.refresh=function(){var e="offset",i=0;t.isWindow(this.$scrollElement[0])||(e="position",i=this.$scrollElement.scrollTop()),this.offsets=[],this.targets=[],this.scrollHeight=this.getScrollHeight();var o=this;this.$body.find(this.selector).map(function(){var o=t(this),s=o.data("target")||o.attr("href"),n=/^#./.test(s)&&t(s);return n&&n.length&&n.is(":visible")&&[[n[e]().top+i,s]]||null}).sort(function(t,e){return t[0]-e[0]}).each(function(){o.offsets.push(this[0]),o.targets.push(this[1])})},e.prototype.process=function(){var t,e=this.$scrollElement.scrollTop()+this.options.offset,i=this.getScrollHeight(),o=this.options.offset+i-this.$scrollElement.height(),s=this.offsets,n=this.targets,a=this.activeTarget;if(this.scrollHeight!=i&&this.refresh(),e>=o)return a!=(t=n[n.length-1])&&this.activate(t);if(a&&e=s[t]&&(!s[t+1]||e<=s[t+1])&&this.activate(n[t])},e.prototype.activate=function(e){this.activeTarget=e,this.clear();var i=this.selector+'[data-target="'+e+'"],'+this.selector+'[href="'+e+'"]',o=t(i).parents("li").addClass("active");o.parent(".dropdown-menu").length&&(o=o.closest("li.dropdown").addClass("active")),o.trigger("activate.bs.scrollspy")},e.prototype.clear=function(){t(this.selector).parentsUntil(this.options.target,".active").removeClass("active")};var o=t.fn.scrollspy;t.fn.scrollspy=i,t.fn.scrollspy.Constructor=e,t.fn.scrollspy.noConflict=function(){return t.fn.scrollspy=o,this},t(window).on("load.bs.scrollspy.data-api",function(){t('[data-spy="scroll"]').each(function(){var e=t(this);i.call(e,e.data())})})}(jQuery),+function(t){"use strict";function e(){var t=document.createElement("bootstrap"),e={WebkitTransition:"webkitTransitionEnd",MozTransition:"transitionend",OTransition:"oTransitionEnd otransitionend",transition:"transitionend"};for(var i in e)if(void 0!==t.style[i])return{end:e[i]};return!1}t.fn.emulateTransitionEnd=function(e){var i=!1,o=this;t(this).one("bsTransitionEnd",function(){i=!0});var s=function(){i||t(o).trigger(t.support.transition.end)};return setTimeout(s,e),this},t(function(){t.support.transition=e(),t.support.transition&&(t.event.special.bsTransitionEnd={bindType:t.support.transition.end,delegateType:t.support.transition.end,handle:function(e){return t(e.target).is(this)?e.handleObj.handler.apply(this,arguments):void 0}})})}(jQuery); \ No newline at end of file diff --git a/docs/API/API/js/jquery-1.11.1.min.js b/docs/API/API/js/jquery-1.11.1.min.js new file mode 100644 index 000000000..ab28a2472 --- /dev/null +++ b/docs/API/API/js/jquery-1.11.1.min.js @@ -0,0 +1,4 @@ +/*! jQuery v1.11.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */ +!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.1",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(o,"ms-").replace(p,q)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=r(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(n,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(r(Object(a))?m.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=r(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),m.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||m.guid++,e):void 0},now:function(){return+new Date},support:k}),m.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function r(a){var b=a.length,c=m.type(a);return"function"===c||m.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var s=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+-new Date,v=a.document,w=0,x=0,y=gb(),z=gb(),A=gb(),B=function(a,b){return a===b&&(l=!0),0},C="undefined",D=1<<31,E={}.hasOwnProperty,F=[],G=F.pop,H=F.push,I=F.push,J=F.slice,K=F.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},L="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",N="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",O=N.replace("w","w#"),P="\\["+M+"*("+N+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+O+"))|)"+M+"*\\]",Q=":("+N+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+P+")*)|.*)\\)|)",R=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),S=new RegExp("^"+M+"*,"+M+"*"),T=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp("="+M+"*([^\\]'\"]*?)"+M+"*\\]","g"),V=new RegExp(Q),W=new RegExp("^"+O+"$"),X={ID:new RegExp("^#("+N+")"),CLASS:new RegExp("^\\.("+N+")"),TAG:new RegExp("^("+N.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+Q),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+L+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ab=/[+~]/,bb=/'|\\/g,cb=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),db=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{I.apply(F=J.call(v.childNodes),v.childNodes),F[v.childNodes.length].nodeType}catch(eb){I={apply:F.length?function(a,b){H.apply(a,J.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fb(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],!a||"string"!=typeof a)return d;if(1!==(k=b.nodeType)&&9!==k)return[];if(p&&!e){if(f=_.exec(a))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return I.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return I.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&(!q||!q.test(a))){if(s=r=u,w=b,x=9===k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(bb,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+qb(o[l]);w=ab.test(a)&&ob(b.parentNode)||b,x=o.join(",")}if(x)try{return I.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function gb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function hb(a){return a[u]=!0,a}function ib(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function jb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function kb(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||D)-(~a.sourceIndex||D);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function lb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function mb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function nb(a){return hb(function(b){return b=+b,hb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function ob(a){return a&&typeof a.getElementsByTagName!==C&&a}c=fb.support={},f=fb.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fb.setDocument=function(a){var b,e=a?a.ownerDocument||a:v,g=e.defaultView;return e!==n&&9===e.nodeType&&e.documentElement?(n=e,o=e.documentElement,p=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){m()},!1):g.attachEvent&&g.attachEvent("onunload",function(){m()})),c.attributes=ib(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ib(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=$.test(e.getElementsByClassName)&&ib(function(a){return a.innerHTML="
",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=ib(function(a){return o.appendChild(a).id=u,!e.getElementsByName||!e.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==C&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){var c=typeof a.getAttributeNode!==C&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==C?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==C&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(e.querySelectorAll))&&(ib(function(a){a.innerHTML="",a.querySelectorAll("[msallowclip^='']").length&&q.push("[*^$]="+M+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+M+"*(?:value|"+L+")"),a.querySelectorAll(":checked").length||q.push(":checked")}),ib(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+M+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ib(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",Q)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===v&&t(v,a)?-1:b===e||b.ownerDocument===v&&t(v,b)?1:k?K.call(k,a)-K.call(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],i=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:k?K.call(k,a)-K.call(k,b):0;if(f===g)return kb(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]===i[d])d++;return d?kb(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},e):n},fb.matches=function(a,b){return fb(a,null,null,b)},fb.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fb(b,n,null,[a]).length>0},fb.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fb.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&E.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fb.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fb.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fb.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fb.selectors={cacheLength:50,createPseudo:hb,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(cb,db),a[3]=(a[3]||a[4]||a[5]||"").replace(cb,db),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fb.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fb.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(cb,db).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+M+")"+a+"("+M+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==C&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fb.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fb.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?hb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=K.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:hb(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));return d[u]?hb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:hb(function(a){return function(b){return fb(a,b).length>0}}),contains:hb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:hb(function(a){return W.test(a||"")||fb.error("unsupported lang: "+a),a=a.replace(cb,db).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:nb(function(){return[0]}),last:nb(function(a,b){return[b-1]}),eq:nb(function(a,b,c){return[0>c?c+b:c]}),even:nb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:nb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:nb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:nb(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function rb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function sb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function tb(a,b,c){for(var d=0,e=b.length;e>d;d++)fb(a,b[d],c);return c}function ub(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function vb(a,b,c,d,e,f){return d&&!d[u]&&(d=vb(d)),e&&!e[u]&&(e=vb(e,f)),hb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||tb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ub(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ub(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?K.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ub(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):I.apply(g,r)})}function wb(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=rb(function(a){return a===b},h,!0),l=rb(function(a){return K.call(b,a)>-1},h,!0),m=[function(a,c,d){return!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>i;i++)if(c=d.relative[a[i].type])m=[rb(sb(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return vb(i>1&&sb(m),i>1&&qb(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&wb(a.slice(i,e)),f>e&&wb(a=a.slice(e)),f>e&&qb(a))}m.push(c)}return sb(m)}function xb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=G.call(i));s=ub(s)}I.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&fb.uniqueSort(i)}return k&&(w=v,j=t),r};return c?hb(f):f}return h=fb.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wb(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xb(e,d)),f.selector=a}return f},i=fb.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(cb,db),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(cb,db),ab.test(j[0].type)&&ob(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qb(j),!a)return I.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,ab.test(a)&&ob(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ib(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ib(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||jb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ib(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||jb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ib(function(a){return null==a.getAttribute("disabled")})||jb(L,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fb}(a);m.find=s,m.expr=s.selectors,m.expr[":"]=m.expr.pseudos,m.unique=s.uniqueSort,m.text=s.getText,m.isXMLDoc=s.isXML,m.contains=s.contains;var t=m.expr.match.needsContext,u=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,v=/^.[^:#\[\.,]*$/;function w(a,b,c){if(m.isFunction(b))return m.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return m.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(v.test(b))return m.filter(b,a,c);b=m.filter(b,a)}return m.grep(a,function(a){return m.inArray(a,b)>=0!==c})}m.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?m.find.matchesSelector(d,a)?[d]:[]:m.find.matches(a,m.grep(b,function(a){return 1===a.nodeType}))},m.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(m(a).filter(function(){for(b=0;e>b;b++)if(m.contains(d[b],this))return!0}));for(b=0;e>b;b++)m.find(a,d[b],c);return c=this.pushStack(e>1?m.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(w(this,a||[],!1))},not:function(a){return this.pushStack(w(this,a||[],!0))},is:function(a){return!!w(this,"string"==typeof a&&t.test(a)?m(a):a||[],!1).length}});var x,y=a.document,z=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=m.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||x).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof m?b[0]:b,m.merge(this,m.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:y,!0)),u.test(c[1])&&m.isPlainObject(b))for(c in b)m.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=y.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return x.find(a);this.length=1,this[0]=d}return this.context=y,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):m.isFunction(a)?"undefined"!=typeof x.ready?x.ready(a):a(m):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),m.makeArray(a,this))};A.prototype=m.fn,x=m(y);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};m.extend({dir:function(a,b,c){var d=[],e=a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!m(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),m.fn.extend({has:function(a){var b,c=m(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(m.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=t.test(a)||"string"!=typeof a?m(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&m.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?m.unique(f):f)},index:function(a){return a?"string"==typeof a?m.inArray(this[0],m(a)):m.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(m.unique(m.merge(this.get(),m(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function D(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}m.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return m.dir(a,"parentNode")},parentsUntil:function(a,b,c){return m.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return m.dir(a,"nextSibling")},prevAll:function(a){return m.dir(a,"previousSibling")},nextUntil:function(a,b,c){return m.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return m.dir(a,"previousSibling",c)},siblings:function(a){return m.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return m.sibling(a.firstChild)},contents:function(a){return m.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:m.merge([],a.childNodes)}},function(a,b){m.fn[a]=function(c,d){var e=m.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=m.filter(d,e)),this.length>1&&(C[a]||(e=m.unique(e)),B.test(a)&&(e=e.reverse())),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return m.each(a.match(E)||[],function(a,c){b[c]=!0}),b}m.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):m.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){m.each(b,function(b,c){var d=m.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&m.each(arguments,function(a,c){var d;while((d=m.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?m.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},m.extend({Deferred:function(a){var b=[["resolve","done",m.Callbacks("once memory"),"resolved"],["reject","fail",m.Callbacks("once memory"),"rejected"],["notify","progress",m.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return m.Deferred(function(c){m.each(b,function(b,f){var g=m.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&m.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?m.extend(a,d):d}},e={};return d.pipe=d.then,m.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&m.isFunction(a.promise)?e:0,g=1===f?a:m.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&m.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;m.fn.ready=function(a){return m.ready.promise().done(a),this},m.extend({isReady:!1,readyWait:1,holdReady:function(a){a?m.readyWait++:m.ready(!0)},ready:function(a){if(a===!0?!--m.readyWait:!m.isReady){if(!y.body)return setTimeout(m.ready);m.isReady=!0,a!==!0&&--m.readyWait>0||(H.resolveWith(y,[m]),m.fn.triggerHandler&&(m(y).triggerHandler("ready"),m(y).off("ready")))}}});function I(){y.addEventListener?(y.removeEventListener("DOMContentLoaded",J,!1),a.removeEventListener("load",J,!1)):(y.detachEvent("onreadystatechange",J),a.detachEvent("onload",J))}function J(){(y.addEventListener||"load"===event.type||"complete"===y.readyState)&&(I(),m.ready())}m.ready.promise=function(b){if(!H)if(H=m.Deferred(),"complete"===y.readyState)setTimeout(m.ready);else if(y.addEventListener)y.addEventListener("DOMContentLoaded",J,!1),a.addEventListener("load",J,!1);else{y.attachEvent("onreadystatechange",J),a.attachEvent("onload",J);var c=!1;try{c=null==a.frameElement&&y.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!m.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}I(),m.ready()}}()}return H.promise(b)};var K="undefined",L;for(L in m(k))break;k.ownLast="0"!==L,k.inlineBlockNeedsLayout=!1,m(function(){var a,b,c,d;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",k.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(d))}),function(){var a=y.createElement("div");if(null==k.deleteExpando){k.deleteExpando=!0;try{delete a.test}catch(b){k.deleteExpando=!1}}a=null}(),m.acceptData=function(a){var b=m.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var M=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,N=/([A-Z])/g;function O(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(N,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:M.test(c)?m.parseJSON(c):c}catch(e){}m.data(a,b,c)}else c=void 0}return c}function P(a){var b;for(b in a)if(("data"!==b||!m.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function Q(a,b,d,e){if(m.acceptData(a)){var f,g,h=m.expando,i=a.nodeType,j=i?m.cache:a,k=i?a[h]:a[h]&&h; +if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||m.guid++:h),j[k]||(j[k]=i?{}:{toJSON:m.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=m.extend(j[k],b):j[k].data=m.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[m.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[m.camelCase(b)])):f=g,f}}function R(a,b,c){if(m.acceptData(a)){var d,e,f=a.nodeType,g=f?m.cache:a,h=f?a[m.expando]:m.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){m.isArray(b)?b=b.concat(m.map(b,m.camelCase)):b in d?b=[b]:(b=m.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!P(d):!m.isEmptyObject(d))return}(c||(delete g[h].data,P(g[h])))&&(f?m.cleanData([a],!0):k.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}m.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?m.cache[a[m.expando]]:a[m.expando],!!a&&!P(a)},data:function(a,b,c){return Q(a,b,c)},removeData:function(a,b){return R(a,b)},_data:function(a,b,c){return Q(a,b,c,!0)},_removeData:function(a,b){return R(a,b,!0)}}),m.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=m.data(f),1===f.nodeType&&!m._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=m.camelCase(d.slice(5)),O(f,d,e[d])));m._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){m.data(this,a)}):arguments.length>1?this.each(function(){m.data(this,a,b)}):f?O(f,a,m.data(f,a)):void 0},removeData:function(a){return this.each(function(){m.removeData(this,a)})}}),m.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=m._data(a,b),c&&(!d||m.isArray(c)?d=m._data(a,b,m.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=m.queue(a,b),d=c.length,e=c.shift(),f=m._queueHooks(a,b),g=function(){m.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return m._data(a,c)||m._data(a,c,{empty:m.Callbacks("once memory").add(function(){m._removeData(a,b+"queue"),m._removeData(a,c)})})}}),m.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.lengthh;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},W=/^(?:checkbox|radio)$/i;!function(){var a=y.createElement("input"),b=y.createElement("div"),c=y.createDocumentFragment();if(b.innerHTML="
a",k.leadingWhitespace=3===b.firstChild.nodeType,k.tbody=!b.getElementsByTagName("tbody").length,k.htmlSerialize=!!b.getElementsByTagName("link").length,k.html5Clone="<:nav>"!==y.createElement("nav").cloneNode(!0).outerHTML,a.type="checkbox",a.checked=!0,c.appendChild(a),k.appendChecked=a.checked,b.innerHTML="",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,c.appendChild(b),b.innerHTML="",k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,k.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){k.noCloneEvent=!1}),b.cloneNode(!0).click()),null==k.deleteExpando){k.deleteExpando=!0;try{delete b.test}catch(d){k.deleteExpando=!1}}}(),function(){var b,c,d=y.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(k[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),k[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var X=/^(?:input|select|textarea)$/i,Y=/^key/,Z=/^(?:mouse|pointer|contextmenu)|click/,$=/^(?:focusinfocus|focusoutblur)$/,_=/^([^.]*)(?:\.(.+)|)$/;function ab(){return!0}function bb(){return!1}function cb(){try{return y.activeElement}catch(a){}}m.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=m.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof m===K||a&&m.event.triggered===a.type?void 0:m.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(E)||[""],h=b.length;while(h--)f=_.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=m.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=m.event.special[o]||{},l=m.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&m.expr.match.needsContext.test(e),namespace:p.join(".")},i),(n=g[o])||(n=g[o]=[],n.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?n.splice(n.delegateCount++,0,l):n.push(l),m.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m.hasData(a)&&m._data(a);if(r&&(k=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=_.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=m.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,n=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=n.length;while(f--)g=n[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(n.splice(f,1),g.selector&&n.delegateCount--,l.remove&&l.remove.call(a,g));i&&!n.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||m.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)m.event.remove(a,o+b[j],c,d,!0);m.isEmptyObject(k)&&(delete r.handle,m._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,n,o=[d||y],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||y,3!==d.nodeType&&8!==d.nodeType&&!$.test(p+m.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[m.expando]?b:new m.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:m.makeArray(c,[b]),k=m.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!m.isWindow(d)){for(i=k.delegateType||p,$.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||y)&&o.push(l.defaultView||l.parentWindow||a)}n=0;while((h=o[n++])&&!b.isPropagationStopped())b.type=n>1?i:k.bindType||p,f=(m._data(h,"events")||{})[b.type]&&m._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&m.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&m.acceptData(d)&&g&&d[p]&&!m.isWindow(d)){l=d[g],l&&(d[g]=null),m.event.triggered=p;try{d[p]()}catch(r){}m.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=m.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(m._data(this,"events")||{})[a.type]||[],k=m.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=m.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((m.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?m(c,this).index(i)>=0:m.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,handlers:e})}return h]","i"),hb=/^\s+/,ib=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,jb=/<([\w:]+)/,kb=/\s*$/g,rb={option:[1,""],legend:[1,"
","
"],area:[1,"",""],param:[1,"",""],thead:[1,"","
"],tr:[2,"","
"],col:[2,"","
"],td:[3,"","
"],_default:k.htmlSerialize?[0,"",""]:[1,"X
","
"]},sb=db(y),tb=sb.appendChild(y.createElement("div"));rb.optgroup=rb.option,rb.tbody=rb.tfoot=rb.colgroup=rb.caption=rb.thead,rb.th=rb.td;function ub(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==K?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==K?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||m.nodeName(d,b)?f.push(d):m.merge(f,ub(d,b));return void 0===b||b&&m.nodeName(a,b)?m.merge([a],f):f}function vb(a){W.test(a.type)&&(a.defaultChecked=a.checked)}function wb(a,b){return m.nodeName(a,"table")&&m.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function xb(a){return a.type=(null!==m.find.attr(a,"type"))+"/"+a.type,a}function yb(a){var b=pb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function zb(a,b){for(var c,d=0;null!=(c=a[d]);d++)m._data(c,"globalEval",!b||m._data(b[d],"globalEval"))}function Ab(a,b){if(1===b.nodeType&&m.hasData(a)){var c,d,e,f=m._data(a),g=m._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)m.event.add(b,c,h[c][d])}g.data&&(g.data=m.extend({},g.data))}}function Bb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!k.noCloneEvent&&b[m.expando]){e=m._data(b);for(d in e.events)m.removeEvent(b,d,e.handle);b.removeAttribute(m.expando)}"script"===c&&b.text!==a.text?(xb(b).text=a.text,yb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),k.html5Clone&&a.innerHTML&&!m.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&W.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}m.extend({clone:function(a,b,c){var d,e,f,g,h,i=m.contains(a.ownerDocument,a);if(k.html5Clone||m.isXMLDoc(a)||!gb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(tb.innerHTML=a.outerHTML,tb.removeChild(f=tb.firstChild)),!(k.noCloneEvent&&k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||m.isXMLDoc(a)))for(d=ub(f),h=ub(a),g=0;null!=(e=h[g]);++g)d[g]&&Bb(e,d[g]);if(b)if(c)for(h=h||ub(a),d=d||ub(f),g=0;null!=(e=h[g]);g++)Ab(e,d[g]);else Ab(a,f);return d=ub(f,"script"),d.length>0&&zb(d,!i&&ub(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,l,n=a.length,o=db(b),p=[],q=0;n>q;q++)if(f=a[q],f||0===f)if("object"===m.type(f))m.merge(p,f.nodeType?[f]:f);else if(lb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(jb.exec(f)||["",""])[1].toLowerCase(),l=rb[i]||rb._default,h.innerHTML=l[1]+f.replace(ib,"<$1>")+l[2],e=l[0];while(e--)h=h.lastChild;if(!k.leadingWhitespace&&hb.test(f)&&p.push(b.createTextNode(hb.exec(f)[0])),!k.tbody){f="table"!==i||kb.test(f)?""!==l[1]||kb.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)m.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}m.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),k.appendChecked||m.grep(ub(p,"input"),vb),q=0;while(f=p[q++])if((!d||-1===m.inArray(f,d))&&(g=m.contains(f.ownerDocument,f),h=ub(o.appendChild(f),"script"),g&&zb(h),c)){e=0;while(f=h[e++])ob.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:function(a,b){for(var d,e,f,g,h=0,i=m.expando,j=m.cache,l=k.deleteExpando,n=m.event.special;null!=(d=a[h]);h++)if((b||m.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)n[e]?m.event.remove(d,e):m.removeEvent(d,e,g.handle);j[f]&&(delete j[f],l?delete d[i]:typeof d.removeAttribute!==K?d.removeAttribute(i):d[i]=null,c.push(f))}}}),m.fn.extend({text:function(a){return V(this,function(a){return void 0===a?m.text(this):this.empty().append((this[0]&&this[0].ownerDocument||y).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?m.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||m.cleanData(ub(c)),c.parentNode&&(b&&m.contains(c.ownerDocument,c)&&zb(ub(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&m.cleanData(ub(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&m.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return m.clone(this,a,b)})},html:function(a){return V(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(fb,""):void 0;if(!("string"!=typeof a||mb.test(a)||!k.htmlSerialize&&gb.test(a)||!k.leadingWhitespace&&hb.test(a)||rb[(jb.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(ib,"<$1>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(m.cleanData(ub(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,m.cleanData(ub(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,n=this,o=l-1,p=a[0],q=m.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&nb.test(p))return this.each(function(c){var d=n.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(i=m.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=m.map(ub(i,"script"),xb),f=g.length;l>j;j++)d=i,j!==o&&(d=m.clone(d,!0,!0),f&&m.merge(g,ub(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,m.map(g,yb),j=0;f>j;j++)d=g[j],ob.test(d.type||"")&&!m._data(d,"globalEval")&&m.contains(h,d)&&(d.src?m._evalUrl&&m._evalUrl(d.src):m.globalEval((d.text||d.textContent||d.innerHTML||"").replace(qb,"")));i=c=null}return this}}),m.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){m.fn[a]=function(a){for(var c,d=0,e=[],g=m(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),m(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Cb,Db={};function Eb(b,c){var d,e=m(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:m.css(e[0],"display");return e.detach(),f}function Fb(a){var b=y,c=Db[a];return c||(c=Eb(a,b),"none"!==c&&c||(Cb=(Cb||m("