File: docs/ClassMgr.md

Example 1

<?php

$code = ClassMgr::init()
    ->setName( 'TestClass' )
    ->addProperty(
        PropertyMgr::factory( 'propertyName', PropertyMgr::STRING_T )
    )
    ->toString()

Result :

/
 * Class TestClass
 */
class TestClass
{
    /
     * @var string
     */
    private $propertyName = null;

    /
     * Return string propertyName
     *
     * @return string
     */
    public function getPropertyName() : string
    {
        return $this->propertyName;
    }

    /
     * Return bool true if  propertyName  is set (i.e. not null)
     *
     * @return bool
     */
    public function isPropertyNameSet() : bool
    {
        return ( null !== $this->propertyName );
    }

    /
     * Set propertyName
     *
     * @param  string $propertyName
     * @return static
     */
    public function setPropertyName( string $propertyName )
    {
        $this->propertyName = $propertyName;
        return $this;
    }
}

Example 2

<?php

$code = ClassMgr::init()
    ->setNamespace( __NAMESPACE__ )
    ->setName( 'TestClass' )
    ->setProperties(
        PropertyMgr::factory(
            'variable',
            ClassMgr::ARRAY_T,
            ClassMgr::ARRAY2_T,
            'An array of values'
        )
    )
    ->toString();

Result :

namespace Kigkonsult\PcGen;

use ArrayIterator;
use Countable;
use OutOfBoundsException;
use SeekableIterator;
use Traversable;

/
 * Class TestClass
 *
 * @package Kigkonsult\PcGen
 */
class TestClass
     implements SeekableIterator, Countable
{
    /
     * An array of values
     *
     * @var array
     */
    private $variable = [];

    /
     * Iterator index
     *
     * @var int
     */
    private $position = 0;

    /
     * Return count of variable elements
     *
     * Required method implementing the Countable interface
     *
     * @return int
     */
    public function count() : int
    {
        return count( $this->variable );
    }

    /
     * Return the current element
     *
     * Required method implementing the Iterator interface
     *
     * @return mixed
     */
    public function current()
    {
        return $this->variable[$this->position];
    }

    /
     * Checks if position is set
     *
     * @param  int $position
     * @return bool
     */
    public function exists( int $position ) : bool
    {
        return array_key_exists( $position, $this->variable );
    }

    /
     * Retrieve an external iterator
     *
     * Method implementing the IteratorAggregate interface,
     * returning Traversable, i.e. makes the class traversable using foreach.
     * Usage : 'foreach( $class as $value ) { .... }'
     *
     * @return Traversable
     */
    public function GetIterator() : Traversable
    {
        return new ArrayIterator( $this->variable );
    }

    /
     * Return the key of the current element
     *
     * Required method implementing the Iterator interface
     *
     * @return int
     */
    public function key() : int
    {
        return $this->position;
    }

    /
     * Move position to last element
     *
     * @return static
     */
    public function last()
    {
        $this->position = count( $this->variable ) - 1;
        return $this;
    }

    /
     * Move position forward to next element
     *
     * Required method implementing the Iterator interface
     *
     * @return static
     */
    public function next()
    {
        $this->position += 1;
        return $this;
    }

    /
     * Move position backward to previous element
     *
     * @return static
     */
    public function previous()
    {
        $this->position -= 1;
        return $this;
    }

    /
     * Rewind the Iterator to the first element
     *
     * Required method implementing the Iterator interface
     *
     * @return static
     */
    public function rewind()
    {
        $this->position = 0;
        return $this;
    }

    /
     * Seeks to a given position in the iterator
     *
     * Required method implementing the SeekableIterator interface
     *
     * @param  int $position
     * @return void
     * @throws OutOfBoundsException
     */
    public function seek( $position )
    {
        static $ERRTXT = "Position %d not found!";
        if( ! array_key_exists( $position, $this->variable )) {
            throw new OutOfBoundsException( sprintf( $ERRTXT, $position ));
        }
        $this->position = $position;
    }

    /
     * Checks if current position is valid
     *
     * Required method implementing the Iterator interface
     *
     * @return bool
     */
    public function valid() : bool
    {
        return array_key_exists( $this->position, $this->variable );
    }

    /
     * Append an variable array element
     *
     * @param  mixed $variable
     * @return static
     */
    public function appendVariable( $variable )
    {
        $this->variable[] = $variable;
        return $this;
    }

    /
     * Set variable
     *
     * @param  array $variable
     * @return static
     */
    public function setVariable( array $variable = [] )
    {
        $this->variable = $variable;
        return $this;
    }
}

<small>Return to [README] - [Summary]</small>

[ArgumentDto]:ArgumentDto.md [FcnFrameMgr]:FcnFrameMgr.md [FcnInvokeMgr]:FcnInvokeMgr.md [Common methods]:CommonMethods.md [DocBlockMgr]:DocBlockMgr.md [phpdoc]:https://phpdoc.org [PropertyMgr]:PropertyMgr.md [README]:../README.md [Summary]:Summary.md [VarDto]:VarDto.md