Skip to content

Commit

Permalink
Fixes zendframework#1366 - Missing data types for Zend\Barcode
Browse files Browse the repository at this point in the history
  • Loading branch information
@froschdesign
froschdesign committed Jan 5, 2015
1 parent 73a6529 commit 04fd35c
Showing 1 changed file with 37 additions and 37 deletions.
74 changes: 37 additions & 37 deletions docs/languages/en/modules/zend.barcode.objects.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,43 +53,43 @@ corresponding getter prefixed with "get" (e.g. "getBarHeight"). Available option

.. table:: Common Options

+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|Option |Data Type |Default Value |Description |
+==================+=================+=====================+===========================================================================================================+
|barcodeNamespace |String |Zend\\Barcode\\Object|Namespace of the barcode; for example, if you need to extend the embedding objects |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|barHeight |Integer |50 |Height of the bars |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|barThickWidth |Integer |3 |Width of the thick bar |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|barThinWidth |Integer |1 |Width of the thin bar |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|factor |Integer |1 |Factor by which to multiply bar widths and font sizes (barHeight, barThinWidth, barThickWidth and fontSize)|
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|foreColor |Integer |0x000000 (black) |Color of the bar and the text. Could be provided as an integer or as a HTML value (e.g. "#333333") |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|backgroundColor |Integer or String|0xFFFFFF (white) |Color of the background. Could be provided as an integer or as a HTML value (e.g. "#333333") |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|orientation |Float |0 |Orientation of the barcode |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|font |String or Integer|NULL |Font path to a TTF font or a number between 1 and 5 if using image generation with GD (internal fonts) |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|fontSize |Float |10 |Size of the font (not applicable with numeric fonts) |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|withBorder |Boolean |FALSE |Draw a border around the barcode and the quiet zones |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|withQuietZones |Boolean |TRUE |Leave a quiet zone before and after the barcode |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|drawText |Boolean |TRUE |Set if the text is displayed below the barcode |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|stretchText |Boolean |FALSE |Specify if the text is stretched all along the barcode |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|withChecksum |Boolean |FALSE |Indicate whether or not the checksum is automatically added to the barcode |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|withChecksumInText|Boolean |FALSE |Indicate whether or not the checksum is displayed in the textual representation |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|text |String |NULL |The text to represent as a barcode |
+------------------+-----------------+---------------------+-----------------------------------------------------------------------------------------------------------+
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|Option |Data Type |Default Value |Description |
+==================+=================================+=====================+===========================================================================================================+
|barcodeNamespace |String |Zend\\Barcode\\Object|Namespace of the barcode; for example, if you need to extend the embedding objects |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|barHeight |Integer |50 |Height of the bars |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|barThickWidth |Integer |3 |Width of the thick bar |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|barThinWidth |Integer |1 |Width of the thin bar |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|factor |Integer, Float, String or Boolean|1 |Factor by which to multiply bar widths and font sizes (barHeight, barThinWidth, barThickWidth and fontSize)|
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|foreColor |Integer |0x000000 (black) |Color of the bar and the text. Could be provided as an integer or as a HTML value (e.g. "#333333") |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|backgroundColor |Integer or String |0xFFFFFF (white) |Color of the background. Could be provided as an integer or as a HTML value (e.g. "#333333") |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|orientation |Integer, Float, String or Boolean|0 |Orientation of the barcode |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|font |String or Integer |NULL |Font path to a TTF font or a number between 1 and 5 if using image generation with GD (internal fonts) |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|fontSize |Float |10 |Size of the font (not applicable with numeric fonts) |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|withBorder |Boolean |FALSE |Draw a border around the barcode and the quiet zones |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|withQuietZones |Boolean |TRUE |Leave a quiet zone before and after the barcode |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|drawText |Boolean |TRUE |Set if the text is displayed below the barcode |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|stretchText |Boolean |FALSE |Specify if the text is stretched all along the barcode |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|withChecksum |Boolean |FALSE |Indicate whether or not the checksum is automatically added to the barcode |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|withChecksumInText|Boolean |FALSE |Indicate whether or not the checksum is displayed in the textual representation |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+
|text |String |NULL |The text to represent as a barcode |
+------------------+---------------------------------+---------------------+-----------------------------------------------------------------------------------------------------------+

.. _zend.barcode.barcode.common.options.barcodefont:

Expand Down

0 comments on commit 04fd35c

Please sign in to comment.