Zend_Text_Table_Column Class Reference

Public Member Functions
	__construct ($content=null, $align=null, $colSpan=null, $charset=null)
	setContent ($content, $charset=null)
	setAlign ($align)
	setColSpan ($colSpan)
	getColSpan ()
	render ($columnWidth, $padding=0)

Data Fields
const	ALIGN_LEFT = 'left'
const	ALIGN_CENTER = 'center'
const	ALIGN_RIGHT = 'right'

Protected Attributes
	$_content = ''
	$_align = self::ALIGN_LEFT
	$_colSpan = 1
	$_allowedAligns = array(self::ALIGN_LEFT, self::ALIGN_CENTER, self::ALIGN_RIGHT)

Detailed Description

Definition at line 40 of file Column.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$content = null,
			$align = null,
			$colSpan = null,
			$charset = null
	)

Create a column for a Zend_Text_Table_Row object.

Parameters

string	$content	The content of the column
string	$align	The align of the content
integer	$colSpan	The colspan of the column
string	$charset	The encoding of the content

Definition at line 85 of file Column.php.

    {
        if ($content !== null) {
            $this->setContent($content, $charset);
        }

        if ($align !== null) {
            $this->setAlign($align);
        }

        if ($colSpan !== null) {
            $this->setColSpan($colSpan);
        }
    }

Member Function Documentation

getColSpan()

getColSpan

(

)

Get the colspan

Returns

integer

Definition at line 183 of file Column.php.

    {
        return $this->_colSpan;
    }

render()

render	(		$columnWidth,
			$padding = 0
	)

Render the column width the given column width

Parameters

integer	$columnWidth	The width of the column
integer	$padding	The padding for the column

Exceptions

Zend_Text_Table_Exception	When $columnWidth is lower than 1
Zend_Text_Table_Exception	When padding is greater than columnWidth

Returns

string

Definition at line 197 of file Column.php.

    {
        if (is_int($columnWidth) === false or $columnWidth < 1) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('$columnWidth must be an integer and greater than 0');
        }

        $columnWidth -= ($padding * 2);

        if ($columnWidth < 1) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('Padding (' . $padding . ') is greater than column width');
        }

        switch ($this->_align) {
            case self::ALIGN_LEFT:
                $padMode = STR_PAD_RIGHT;
                break;

            case self::ALIGN_CENTER:
                $padMode = STR_PAD_BOTH;
                break;

            case self::ALIGN_RIGHT:
                $padMode = STR_PAD_LEFT;
                break;

            default:
                // This can never happen, but the CS tells I have to have it ...
                break;
        }

        $outputCharset = Zend_Text_Table::getOutputCharset();
        $lines         = explode("\n", Zend_Text_MultiByte::wordWrap($this->_content, $columnWidth, "\n", true, $outputCharset));
        $paddedLines   = array();

        foreach ($lines AS $line) {
            $paddedLines[] = str_repeat(' ', $padding)
                           . Zend_Text_MultiByte::strPad($line, $columnWidth, ' ', $padMode, $outputCharset)
                           . str_repeat(' ', $padding);
        }

        $result = implode("\n", $paddedLines);

        return $result;
    }

setAlign()

setAlign

(

$align

)

Set the align

Parameters

string

$align

Align of the column

Exceptions

Zend_Text_Table_Exception

When supplied align is invalid

Returns

Zend_Text_Table_Column

Definition at line 147 of file Column.php.

    {
        if (in_array($align, $this->_allowedAligns) === false) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('Invalid align supplied');
        }

        $this->_align = $align;

        return $this;
    }

setColSpan()

setColSpan

(

$colSpan

)

Set the colspan

Parameters

int

$colSpan

Exceptions

Zend_Text_Table_Exception

When $colSpan is smaller than 1

Returns

Zend_Text_Table_Column

Definition at line 166 of file Column.php.

    {
        if (is_int($colSpan) === false or $colSpan < 1) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('$colSpan must be an integer and greater than 0');
        }

        $this->_colSpan = $colSpan;

        return $this;
    }

setContent()

setContent	(		$content,
			$charset = null
	)

Set the content.

If $charset is not defined, it is assumed that $content is encoded in the charset defined via Zend_Text_Table::setInputCharset() (defaults to utf-8).

Parameters

string	$content	Content of the column
string	$charset	The charset of the content

Exceptions

Zend_Text_Table_Exception

When $content is not a string

Returns

Zend_Text_Table_Column

Definition at line 112 of file Column.php.

    {
        if (is_string($content) === false) {
            #require_once 'Zend/Text/Table/Exception.php';
            throw new Zend_Text_Table_Exception('$content must be a string');
        }

        if ($charset === null) {
            $inputCharset = Zend_Text_Table::getInputCharset();
        } else {
            $inputCharset = strtolower($charset);
        }

        $outputCharset = Zend_Text_Table::getOutputCharset();

        if ($inputCharset !== $outputCharset) {
            if (PHP_OS !== 'AIX') {
                // AIX does not understand these character sets
                $content = iconv($inputCharset, $outputCharset, $content);
            }

        }

        $this->_content = $content;

        return $this;
    }

Field Documentation

$_align

$_align = self::ALIGN_LEFT

protected

Definition at line 61 of file Column.php.

$_allowedAligns

$_allowedAligns = array(self::ALIGN_LEFT, self::ALIGN_CENTER, self::ALIGN_RIGHT)

protected

Definition at line 75 of file Column.php.

$_colSpan

$_colSpan = 1

protected

Definition at line 68 of file Column.php.

$_content

$_content = ''

protected

Definition at line 54 of file Column.php.

ALIGN_CENTER

const ALIGN_CENTER = 'center'

Definition at line 46 of file Column.php.

ALIGN_LEFT

const ALIGN_LEFT = 'left'

Aligns for columns

Definition at line 45 of file Column.php.

ALIGN_RIGHT

const ALIGN_RIGHT = 'right'

Definition at line 47 of file Column.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Text/Table/Column.php