### Get PNG Data with Imagick Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-Raw Retrieves the barcode as a PNG image. This method requires the Imagick library to be installed. ```APIDOC public getPngDataImagick() : string Throws: Exception - if the Imagick library is not installed Returns: string ``` -------------------------------- ### API Documentation for printLaunchHelp() Function (PHP) Source: https://tcpdf.org/docs/srcdoc/TCPDF/files-tests-launch This section provides API documentation for the `printLaunchHelp()` function, which is part of the `launch.php` test runner script. It details the function's signature and its return type, indicating its role in outputting help information. ```APIDOC Function: printLaunchHelp() - Description: This function is responsible for printing the help message for the TCPDF test runner. - Return Type: mixed - Source File: launch.php - Line Number: 32 ``` -------------------------------- ### Get PNG Data with Imagick Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-InterleavedTwoOfFiveCheck Retrieves the barcode as a PNG image. This method requires the Imagick library to be installed on the system. An Exception is thrown if the Imagick library is not found or installed, indicating a dependency issue. ```APIDOC getPngDataImagick(): string Returns: string Throws: Exception (if the Imagick library is not installed) ``` -------------------------------- ### Execute TCPDF Test Runner with Help Option (PHP) Source: https://tcpdf.org/docs/srcdoc/TCPDF/files-tests-launch This snippet demonstrates the command-line usage for the `launch.php` test runner script to display its help message. This is a common method to understand the available options and arguments for a command-line utility. ```PHP php launch.php --help ``` -------------------------------- ### API: printLaunchHelp() function signature Source: https://tcpdf.org/docs/srcdoc/TCPDF/namespaces-tecnickcom-tcpdf-tests Provides the signature for the `printLaunchHelp()` function. This function is defined in `launch.php` and is likely used to display help information for launching tests within the TCPDF testing framework. ```APIDOC Function: printLaunchHelp() Source: launch.php:32 Signature: printLaunchHelp() : mixed ``` -------------------------------- ### API: Get PNG Data with Imagick Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Square-PdfFourOneSeven-Sequence Retrieves the barcode as a PNG image. This method requires the Imagick library to be installed. ```APIDOC getPngDataImagick(): string Description: Get the barcode as PNG image (requires Imagick library) Throws: Exception - if the Imagick library is not installed Returns: string ``` -------------------------------- ### Get PNG Data (Imagick) Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-EanOneThree Retrieves the barcode as a PNG image. This method requires the Imagick library to be installed on the system. ```APIDOC public getPngDataImagick(): string Description: Get the barcode as PNG image (requires Imagick library) Throws: Exception: if the Imagick library is not installed Returns: string ``` -------------------------------- ### startLayer() Method Source: https://tcpdf.org/docs/srcdoc/TCPDF/classes-TCPDF Starts a new PDF layer. Allows control over layer visibility for printing and viewing, and provides an option to lock the layer. ```APIDOC public startLayer([string $name = ''][, bool|null $print = true][, bool $view = true][, bool $lock = true]) : mixed $name : string = '' : Layer name (only a-z letters and numbers). Leave empty for automatic name. $print : bool|null = true : Set to TRUE to print this layer, FALSE to not print and NULL to not set this option $view : bool = true : Set to true to view this layer. $lock : bool = true : If true lock the layer ``` -------------------------------- ### API Documentation for Com\Tecnick\Barcode\Type\Square\QrCode\Init Class Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Square-QrCode-Init Detailed API documentation for the `Init` class, which extends `Mask`, including its properties and constructor method with parameter descriptions. ```APIDOC class Com\Tecnick\Barcode\Type\Square\QrCode\Init extends Com\Tecnick\Barcode\Type\Square\QrCode\Mask Description: Initializes QR code generation parameters. Properties: $version: public int Description: QR code version. The size of the QR code is defined by its version, an integer from 1 to 40. Version 1 is a 21x21 matrix, with 4 modules increasing per version, up to version 40 (177x177 matrix). Methods: __construct(int $version, int $level, int $qr_find_from_random = -1, bool $qr_find_best_mask = true, int $qr_default_mask = 2): mixed Description: Initializes the QR code mask. Parameters: $version: int Description: Code version. $level: int Description: Error Correction Level. $qr_find_from_random: int = -1 Description: If negative, checks all available masks. Otherwise, the value indicates the number of masks to be checked, with mask IDs chosen randomly. $qr_find_best_mask: bool = true Description: If true, estimates the best mask (this is a slow operation). $qr_default_mask: int = 2 Description: Default mask used when $qr_find_best_mask is false. ``` -------------------------------- ### Get Barcode as GD Image Object Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Square-Raw Generates and returns the barcode as a GD image object. Requires the GD library to be installed. ```APIDOC public getGd() : GdImage Throws: Exception: if the GD library is not installed Return values: GdImage ``` -------------------------------- ### Get PNG Data (Imagick) Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-EanEight Retrieves the barcode as a PNG image, requiring the Imagick library. Throws an exception if Imagick is not installed. ```APIDOC Method: getPngDataImagick Description: Get the barcode as PNG image (requires Imagick library) Signature: public getPngDataImagick() : string Throws: Exception: if the Imagick library is not installed Return values: string ``` -------------------------------- ### TCPDF Application Package Functions Overview Source: https://tcpdf.org/docs/srcdoc/TCPDF/packages-Application Documents the global functions available in the TCPDF 'Application' package. These functions provide help information for command-line tools related to comparing test runs and launching tests. ```APIDOC Functions: - printCompareRunsHelp(): mixed Source: compare_runs.php (line 37) - printLaunchHelp(): mixed Source: launch.php (line 32) ``` -------------------------------- ### Get PNG Data from Barcode using Imagick Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Square-Raw Retrieves the barcode as a PNG image. This method requires the Imagick library to be installed and available. ```APIDOC public getPngDataImagick(): string Throws: Exception: if the Imagick library is not installed Returns: string ``` -------------------------------- ### initStyle() Source: https://tcpdf.org/docs/srcdoc/tc-lib-pdf-graph/classes-Com-Tecnick-Pdf-Graph-Raw Initializes the default style settings. ```APIDOC initStyle: public initStyle(): void ``` -------------------------------- ### startTemplate() Method Source: https://tcpdf.org/docs/srcdoc/TCPDF/classes-TCPDF Starts a new XObject Template. An XObject Template is a self-contained PDF block that can be painted multiple times. Note that X,Y coordinates will be reset to 0,0 within the template. ```APIDOC public startTemplate([int $w = 0][, int $h = 0][, mixed $group = false]) : string|false An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images). An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked. Note: X,Y coordinates will be reset to 0,0. ``` -------------------------------- ### Get Barcode as GD Image Object (getGd) Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Square-PdfFourOneSeven-Compaction Generates and retrieves the barcode as a GD image object. Requires the GD library to be installed. ```APIDOC getGd(): GdImage Throws: Exception: if the GD library is not installed Return values: GdImage ``` -------------------------------- ### Com\Tecnick\Barcode\Type\Square\Datamatrix\Encodetxt Methods Summary Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Square-Datamatrix-EncodeTxt Provides a summary of key methods available in the `Encodetxt` class and its parent classes, outlining their primary function. ```APIDOC Methods Summary: encodeTXT(): void Description: Encode TXT encodeTXTC40(): int Description: Encode TXTC40 encodeTXTC40last(): void Description: Encode TXTC40 last The following rules apply when only one or two symbol characters remain in the symbol before the start of the error correction codewords. encodeTXTC40shift(): void Description: Encode TXTC40 shift get253StateCodeword(): int Description: Return the 253-state codeword getPlacementMap(): array Description: Build a placement map. getSwitchEncodingCodeword(): int Description: Get the switching codeword to a new encoding mode (latch codeword) lookAheadTest(): int Description: The look-ahead test scans the data to be encoded to find the best mode (Annex P - steps from J to S). ``` -------------------------------- ### Get barcode as GD image object Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-Postnet Generates and returns the barcode as a GD image object. This method requires the GD library to be installed. ```APIDOC getGd(): GdImage Throws: Exception - if the GD library is not installed Return: GdImage ``` -------------------------------- ### TCPDF Page Class Constructor Source: https://tcpdf.org/docs/srcdoc/tc-lib-pdf-page/classes-Com-Tecnick-Pdf-Page-Page Initializes a new `Page` object, setting up its unit of measure, color, and encryption objects. It includes optional parameters for PDF/A mode, stream compression, and signature approval, providing flexibility for PDF generation. ```APIDOC __construct(string $unit, Pdf $color, Encrypt $encrypt[, bool $pdfa = false][, bool $compress = true][, bool $sigapp = false]) : mixed Parameters: $unit : string Unit of measure ('pt', 'mm', 'cm', 'in'). $color : Pdf Color object. $encrypt : Encrypt Encrypt object. $pdfa : bool = false True if we are in PDF/A mode. $compress : bool = true Set to false to disable stream compression. $sigapp : bool = false True if the signature approval is enabled (for incremental updates). ``` -------------------------------- ### Get PNG Data with Imagick Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-KlantIndex Retrieves the barcode as a PNG image. This method requires the Imagick library to be installed. ```APIDOC public getPngDataImagick() : string throws Exception: if the Imagick library is not installed returns: string ``` -------------------------------- ### TCPDF Open() Method Source: https://tcpdf.org/docs/srcdoc/TCPDF/classes-TCPDF Documents the `Open()` method, which initializes the PDF document generation. It notes that explicit calls are often unnecessary as `AddPage()` handles it automatically. ```APIDOC Method: Open() Source: tcpdf.php : 3033 Description: This method begins the generation of the PDF document. It is not necessary to call it explicitly because AddPage() does it automatically. Note: no page is created by this method. Signature: public Open() : mixed Tags: public since: 1.0 see: AddPage(), Close() ``` -------------------------------- ### Get PNG Data with Imagick Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeThreeNineCheck Retrieves the barcode as a PNG image data string. This method requires the Imagick library to be installed and available. ```APIDOC Method: getPngDataImagick Signature: public getPngDataImagick() : string Description: Get the barcode as PNG image (requires Imagick library) Throws: Exception: if the Imagick library is not installed Returns: string ``` -------------------------------- ### Initialize Page Boxes Source: https://tcpdf.org/docs/srcdoc/tc-lib-pdf-page/classes-Com-Tecnick-Pdf-Page-Page Initializes the standard page boxes (e.g., MediaBox) based on the provided page width and height in points. ```APIDOC setPageBoxes(float $width, float $height): array $width: float - Page width in points. $height: float - Page height in points. Returns: array - Page boxes. ``` -------------------------------- ### Get PNG Data (Imagick) Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeNineThree Retrieves the barcode as a PNG image data string. This method requires the Imagick library to be installed and available. ```APIDOC public getPngDataImagick() : string Throws: Exception: if the Imagick library is not installed Returns: string ``` -------------------------------- ### startPage() Method Source: https://tcpdf.org/docs/srcdoc/TCPDF/classes-TCPDF Starts a new page in the document. The page must be closed using the endPage() function. Supports setting page orientation and format. ```APIDOC public startPage([string $orientation = ''][, mixed $format = ''][, bool $tocpage = false]) : mixed The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards. $orientation : string = '' : page orientation. Possible values are (case insensitive): * P or PORTRAIT (default) * L or LANDSCAPE $format : mixed = '' : The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). $tocpage : bool = false : if true the page is designated to contain the Table-Of-Content. ``` -------------------------------- ### Get Barcode as GD Image Object: getGd() Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeNineThree Generates and returns the barcode as a GD image object. Requires the GD library to be installed. ```APIDOC public getGd() : GdImage Throws: Exception: if the GD library is not installed Return values: GdImage ``` -------------------------------- ### APIDOC: Com\Tecnick\Pdf\Font\Buffer::__construct() Method Source: https://tcpdf.org/docs/srcdoc/tc-lib-pdf-font/classes-Com-Tecnick-Pdf-Font-Buffer Detailed API documentation for the `__construct` method of the `Buffer` class. It initializes the fonts buffer and accepts parameters for unit conversion, subsetting, Unicode mode, and PDF/A mode, returning a font key. ```APIDOC __construct() File: Buffer.php : 97 Description: Initialize fonts buffer Signature: public __construct(float $kunit[, bool $subset = false][, bool $unicode = true][, bool $pdfa = false]) : string Parameters: $kunit (float): Unit of measure conversion ratio. $subset (bool = false): If true embedd only a subset of the fonts (stores only the information related to the used characters); If false embedd full font; This option is valid only for TrueTypeUnicode fonts and it is disabled for PDF/A. If you want to enable users to modify the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only a subset. NOTE: This option is computational and memory intensive. $unicode (bool = true): True if we are in Unicode mode, False otherwhise. $pdfa (bool = false): True if we are in PDF/A mode. Return values: string - Font key ``` -------------------------------- ### Get PNG Data with Imagick Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-Codabar Retrieves the barcode as a PNG image data string. This method requires the Imagick library to be installed on the system. ```APIDOC Method: getPngDataImagick() Description: Get the barcode as PNG image (requires Imagick library) Signature: public getPngDataImagick(): string Parameters: None Returns: string - PNG image data Throws: Exception - if the Imagick library is not installed ``` -------------------------------- ### Get PNG Data with Imagick Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-StandardTwoOfFiveCheck Retrieves the barcode as a PNG image. This method requires the Imagick library to be installed. An exception is thrown if Imagick is not available. ```APIDOC Method: getPngDataImagick() Description: Get the barcode as PNG image (requires Imagick library) Signature: public getPngDataImagick() : string Throws: - Exception: if the Imagick library is not installed Returns: string ``` -------------------------------- ### Initialize Barcode Object: __construct() Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeNineThree Initializes a new barcode object with specified content, dimensions, color, and padding. It allows for flexible configuration of the barcode's appearance and properties. ```APIDOC public __construct(string $code[, int $width = -1][, int $height = -1][, string $color = 'black'][, array $params = []][, array{: int, : int, : int, : int} $padding = [0, 0, 0, 0]]) : mixed Parameters: $code (string): Barcode content $width (int = -1): Barcode width in user units (excluding padding). A negative value indicates the multiplication factor for each column. $height (int = -1): Barcode height in user units (excluding padding). A negative value indicates the multiplication factor for each row. $color (string = 'black'): Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax) $params (array = []): Array containing extra parameters for the specified barcode type $padding (array{: int, : int, : int, : int} = [0, 0, 0, 0]): Additional padding to add around the barcode (top, right, bottom, left) in user units. A negative value indicates the number or rows or columns. Throws: Exception: in case of error Exception: in case of color error ``` -------------------------------- ### TCPDF __construct() Method Source: https://tcpdf.org/docs/srcdoc/tc-lib-pdf/classes-Com-Tecnick-Pdf-Tcpdf Initializes a new PDF object with configurable parameters such as unit of measure, Unicode support, font subsetting, compression, PDF mode, and an optional encryption object. This method sets up the fundamental properties for PDF document creation. ```APIDOC __construct([string $unit = 'mm'][, bool $isunicode = true][, bool $subsetfont = false][, bool $compress = true][, string $mode = ''][, Encrypt|null $objEncrypt = null]) : mixed Parameters: $unit: string = 'mm' - Unit of measure ('pt', 'mm', 'cm', 'in'). $isunicode: bool = true - True if the document is in Unicode mode. $subsetfont: bool = false - If true subset the embedded fonts to remove the unused characters. $compress: bool = true - Set to false to disable stream compression. $mode: string = '' - PDF mode: "pdfa1", "pdfa2", "pdfa3", "pdfx" or empty. $objEncrypt: Encrypt|null = null - Encryption object. ``` -------------------------------- ### Get PNG Data with Imagick - PHP Barcode Type Class Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-Pharma Retrieves the barcode as a PNG image. This method requires the Imagick library to be installed. ```APIDOC public getPngDataImagick(): string Throws: Exception - if the Imagick library is not installed Returns: string ``` -------------------------------- ### Get Barcode as GD Image Object: getGd() Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-PharmaTwoTracks Generates and returns the barcode as a GD image object. Requires the GD library to be installed and enabled. ```APIDOC Class: Com\Tecnick\Barcode\Type Method: getGd Signature: public getGd() : GdImage Description: Get the barcode as GD image object (requires GD library). Throws: Exception: if the GD library is not installed Returns: GdImage ``` -------------------------------- ### Initialize Barcode Object: __construct() Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-Codabar Initializes a new barcode object with specified content, dimensions, color, extra parameters, and padding. This is the primary method for creating a barcode instance. ```APIDOC __construct( $code: string, $width: int = -1, $height: int = -1, $color: string = 'black', $params: array = [], $padding: array = [0, 0, 0, 0] ) : mixed $code: Barcode content $width: Barcode width in user units (excluding padding). A negative value indicates the multiplication factor for each column. $height: Barcode height in user units (excluding padding). A negative value indicates the multiplication factor for each row. $color: Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax) $params: Array containing extra parameters for the specified barcode type $padding: Additional padding to add around the barcode (top, right, bottom, left) in user units. A negative value indicates the number or rows or columns. Throws: Exception (in case of error) Throws: Exception (in case of color error) ``` -------------------------------- ### PdfTools Class Constructor Source: https://tcpdf.org/docs/srcdoc/TCPDF/classes-Tecnickcom-TCPDF-Tests-PdfTools Initializes the PdfTools class with paths to PDF tool executables and an optional verbose flag. The `$tools` array maps tool names to their executable paths. ```APIDOC PdfTools: __construct(array $tools, bool $verbose = false) $tools: array - Path to PDF tool executables (indexed by tool name) $verbose: bool = false ``` -------------------------------- ### Get barcode as GD image object Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-EanFive Generates and returns the barcode as a GD image object. This method requires the GD library to be installed and enabled. ```APIDOC public getGd() : GdImage Throws: Exception: if the GD library is not installed Return values: GdImage ``` -------------------------------- ### TCPDF::__construct() Source: https://tcpdf.org/docs/srcdoc/TCPDF/classes-TCPDF This is the class constructor. It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes). ```APIDOC Method Signature: public __construct([string $orientation = 'P'][, string $unit = 'mm'][, mixed $format = 'A4'][, bool $unicode = true][, string $encoding = 'UTF-8'][, bool $diskcache = false][, false|int $pdfa = false]) : mixed Parameters: $orientation (string = 'P'): page orientation. Possible values are (case insensitive): P or Portrait (default), L or Landscape, '' (empty string) for automatic orientation $unit (string = 'mm'): User measure unit. Possible values are: pt: point, mm: millimeter (default), cm: centimeter, in: inch. A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit. $format (mixed = 'A4'): The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat(). $unicode (bool = true): TRUE means that the input text is unicode (default = true) $encoding (string = 'UTF-8'): Charset encoding (used only when converting back html entities); default is UTF-8. $diskcache (bool = false): DEPRECATED FEATURE $pdfa (false|int = false): If not false, set the document to PDF/A mode and the good version (1 or 3). Tags: public see: getPageSizeFromFormat(), setPageFormat() ``` -------------------------------- ### Get PNG Data with Imagick for Barcode Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeThreeNine Retrieves the barcode as a PNG image data string. This method requires the Imagick library to be installed and available. ```APIDOC getPngDataImagick(): string Description: Get the barcode as PNG image (requires Imagick library) Throws: Exception - if the Imagick library is not installed Returns: string ``` -------------------------------- ### Get Barcode as GD Image Object (getGd) - PHP Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeThreeNine Retrieves the barcode as a GD image object. This method requires the GD library to be installed. ```APIDOC getGd(): GdImage Throws: Exception: if the GD library is not installed Return values: GdImage ``` -------------------------------- ### Com\Tecnick\Barcode\Type\Square\QrCode\Split Class API Reference Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Square-QrCode-Split Detailed API documentation for the `Split` class, including its constructor and methods for handling QR code data splitting. ```APIDOC Class: Com\Tecnick\Barcode\Type\Square\QrCode\Split Description: Handles the splitting of QR code data. Methods: __construct(ByteStream $encodingMode, int $hint, int $version): mixed Description: Initialize the Split object. Parameters: $encodingMode (ByteStream): ByteStream Class object. $hint (int): Encoding mode. $version (int): Code version. getSplittedString(string $data): array Description: Split the input string into an array of items. Parameters: $data (string): The input data string to be split. Returns: array: An array of items representing the splitted string. ``` -------------------------------- ### Get PNG Data (Imagick) Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeOneTwoEight Retrieves the barcode as a PNG image. This method requires the Imagick library to be installed. ```APIDOC getPngDataImagick(): string Throws: Exception if the Imagick library is not installed ``` -------------------------------- ### Construct: Initialize a new barcode object Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeOneTwoEight-Process Initializes a new barcode object with various configuration options. Allows setting barcode content, dimensions, foreground color, extra parameters specific to the barcode type, and additional padding around the barcode. ```APIDOC __construct( $code: string, $width: int = -1, $height: int = -1, $color: string = 'black', $params: array = [], $padding: array = [0, 0, 0, 0] ): mixed Parameters: $code (string): Barcode content. $width (int, default: -1): Barcode width in user units (excluding padding). A negative value indicates the multiplication factor for each column. $height (int, default: -1): Barcode height in user units (excluding padding). A negative value indicates the multiplication factor for each row. $color (string, default: 'black'): Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax). $params (array, default: []): Array containing extra parameters for the specified barcode type. $padding (array, default: [0, 0, 0, 0]): Additional padding to add around the barcode (top, right, bottom, left) in user units. A negative value indicates the number of rows or columns. Throws: Exception: In case of error. Exception: In case of color error. ``` -------------------------------- ### Get Barcode as GD Image Object Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Square Retrieves the barcode as a GD image object. This method requires the GD library to be installed on the system to function correctly. ```APIDOC public getGd(): GdImage Throws: [Exception](/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Exception): if the GD library is not installed Returns: GdImage ``` -------------------------------- ### Initialize Barcode Object: __construct() Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-PharmaTwoTracks Initializes a new barcode object with specified content, dimensions, color, additional parameters, and padding. This is the primary constructor for creating barcode instances. ```APIDOC Class: Com\Tecnick\Barcode\Type Method: __construct Signature: public __construct(string $code[, int $width = -1][, int $height = -1][, string $color = 'black'][, array $params = []][, array{: int, : int, : int, : int} $padding = [0, 0, 0, 0] ]) : mixed Description: Initialize a new barcode object. Parameters: $code (string): Barcode content $width (int = -1): Barcode width in user units (excluding padding). A negative value indicates the multiplication factor for each column. $height (int = -1): Barcode height in user units (excluding padding). A negative value indicates the multiplication factor for each row. $color (string = 'black'): Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax) $params (array = []): Array containing extra parameters for the specified barcode type $padding (array{: int, : int, : int, : int} = [0, 0, 0, 0]): Additional padding to add around the barcode (top, right, bottom, left) in user units. A negative value indicates the number or rows or columns. Throws: Exception: in case of error Exception: in case of color error ``` -------------------------------- ### Get Barcode as GD Image Object: getGd Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-UpcA Generates and retrieves the barcode as a GD image object. Requires the GD library to be installed. ```APIDOC public getGd() : GdImage Throws: Exception if the GD library is not installed Returns: GdImage ``` -------------------------------- ### tc-lib-pdf-page API Methods Reference Source: https://tcpdf.org/docs/srcdoc/tc-lib-pdf-page/classes-Com-Tecnick-Pdf-Page-Page Detailed reference for methods related to PDF page creation, manipulation, and region management within the tc-lib-pdf-page library. Each method's signature, return type, and purpose are described. ```APIDOC Methods: __construct() : mixed Description: Initialize page data. add() : PageData Description: Add a new page. addAnnotRef() : void Description: Add Annotation references. addContent() : void Description: Add page content. addContentMark() : void Description: Add page content mark. checkRegionBreak() : PageData Description: Move to the next page region if required. convertPoints() : float Description: Convert Points to another unit. delete() : PageData Description: Remove the specified page. enableAutoPageBreak() : void Description: Enable or disable automatic page break. enableSignatureApproval() : static Description: Enable Signature Approval. getDisplay() : string Description: Get the canonical page display mode. getKUnit() : float Description: Get the unit ratio. getLayout() : string Description: Get the canonical page layout name. getNextPage() : PageData Description: Returns the next page data. getNextRegion() : PageData Description: Returns the page data with the next selected region. getPage() : PageData Description: Returns the specified page data. getPageFormatSize() : array{0: float, 1: float, 2: string} Description: Get page dimensions. getPageID() : int Description: Return the current page ID. getPageOrientation() : string Description: Returns the page orientation. getPageOrientedSize() : array{0: float, 1: float, 2: string} Description: Returns the page dimensions oriented as specified. getPages() : array Description: Returns the array (stack) containing all pages data. getPdfPages() : string Description: Returns the PDF command to output all page sections. getRegion() : RegionData Description: Returns the current region data. getResourceDictObjID() : int Description: Returns the reserved Object ID for the Resource dictionary. getRootObjID() : int Description: Returns the root object ID. getUnitRatio() : float Description: Get the unit ratio for the specified unit of measure. getX() : float Description: Return the absolute horizontal cursor position for the current region. getY() : float Description: Return the absolute vertical cursor position for the current region. isAutoPageBreakEnabled() : bool Description: Return the auto-page-break status. isXOutRegion() : bool Description: Check if the specified horizontal position is outside the region. isYOutRegion() : bool Description: Check if the specified vertical position is outside the region. ``` -------------------------------- ### Get PNG Data (Imagick) Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-StandardTwoOfFive Retrieves the barcode as a PNG image data string. This method requires the Imagick library to be installed and available. ```APIDOC getPngDataImagick: Signature: public getPngDataImagick() : string Description: Get the barcode as PNG image (requires Imagick library) Returns: string Throws: Exception: if the Imagick library is not installed ``` -------------------------------- ### Initialize ByteStream Constructor Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Square-QrCode-ByteStream Initializes a new ByteStream object with specified hint, version, and error correction level. ```APIDOC ByteStream::__construct(int $hint, int $version, int $level): mixed Parameters: $hint (int): Encoding mode $version (int): Code version $level (int): Error Correction Level Returns: mixed ``` -------------------------------- ### Get Barcode as GD Image Object (PHP) Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-StandardTwoOfFiveCheck Generates and retrieves the barcode as a GD image object. This method requires the GD library to be installed on the system. ```APIDOC getGd(): GdImage Throws: Exception: if the GD library is not installed Return values: GdImage ``` -------------------------------- ### Set Page Boundaries (PHP) Source: https://tcpdf.org/docs/srcdoc/tc-lib-pdf-page/classes-Com-Tecnick-Pdf-Page-Settings Set page boundaries. ```APIDOC public setBox(array $dims, string $type, float $llx, float $lly, float $urx, float $ury[, PageBci $bci = null]) : array ``` -------------------------------- ### Get Barcode as GD Image Object Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-ImbPre Generates and returns the barcode as a GD image object. Requires the GD library to be installed, otherwise throws an exception. ```APIDOC public getGd() : GdImage Throws: Exception: if the GD library is not installed Return values: GdImage ``` -------------------------------- ### Initialize Barcode Object: __construct() Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeOneOne Initializes a new barcode object with specified content, dimensions, color, and additional parameters. It allows for custom padding around the barcode. This constructor is crucial for setting up the barcode's properties before rendering or data extraction. It throws exceptions on error or invalid color. ```APIDOC public __construct(string $code[, int $width = -1][, int $height = -1][, string $color = 'black'][, array $params = []][, array{: int, : int, : int, : int} $padding = [0, 0, 0, 0]]) : mixed Parameters: $code (string): Barcode content $width (int = -1): Barcode width in user units (excluding padding). A negative value indicates the multiplication factor for each column. $height (int = -1): Barcode height in user units (excluding padding). A negative value indicates the multiplication factor for each row. $color (string = 'black'): Foreground color in Web notation (color name, or hexadecimal code, or CSS syntax) $params (array = []): Array containing extra parameters for the specified barcode type $padding (array{: int, : int, : int, : int} = [0, 0, 0, 0]): Additional padding to add around the barcode (top, right, bottom, left) in user units. A negative value indicates the number or rows or columns. Throws: Exception: in case of error Exception: in case of color error ``` -------------------------------- ### Get Barcode as GD Image Object: getGd() Source: https://tcpdf.org/docs/srcdoc/tc-lib-barcode/classes-Com-Tecnick-Barcode-Type-Linear-CodeThreeNineExt Generates and returns the barcode as a GD image object. Requires the GD library to be installed. ```APIDOC getGd(): GdImage Throws: Exception: if the GD library is not installed Return values: GdImage ```