ilCtrlStructureCidGenerator Class Reference

Class ilCtrlStructureCidGenerator. More...

Collaboration diagram for ilCtrlStructureCidGenerator:

Public Member Functions
	__construct (int $starting_index=0)
	ilCtrlStructureCidGenerator Constructor More...
	getIndexByCid (string $cid)
	Returns the index of a given cid. More...
	getCidByIndex (int $index)
	Returns the cid for a given index. More...
	getCid ()
	Returns the next available cid. More...

Private Member Functions
	invertIndex (int $index)
	Helper function that inverts an integer value. More...

Private Attributes
int	$index

Detailed Description

Class ilCtrlStructureCidGenerator.

Author

Thibeau Fuhrer thf@s.nosp@m.tude.nosp@m.r-rai.nosp@m.mann.nosp@m..ch

Definition at line 12 of file class.ilCtrlStructureCidGenerator.php.

Constructor & Destructor Documentation

__construct()

ilCtrlStructureCidGenerator::__construct

(

int

$starting_index = 0

)

ilCtrlStructureCidGenerator Constructor

Parameters

int

$starting_index

Definition at line 24 of file class.ilCtrlStructureCidGenerator.php.

    {
        $this->index = $starting_index;
    }

Member Function Documentation

getCid()

ilCtrlStructureCidGenerator::getCid

(

)

Returns the next available cid.

Returns

string

Definition at line 67 of file class.ilCtrlStructureCidGenerator.php.

References getCidByIndex().

                            : string
    {
        return $this->getCidByIndex($this->index++);
    }

Here is the call graph for this function:

getCidByIndex()

ilCtrlStructureCidGenerator::getCidByIndex

(

int

$index

)

Returns the cid for a given index.

Parameters

int

$index

Returns

string

Definition at line 53 of file class.ilCtrlStructureCidGenerator.php.

References invertIndex().

Referenced by getCid().

                                             : string
    {
        if (0 > $index) {
            return '-' . base_convert((string) $this->invertIndex($index), 10, 36);
        }

        return base_convert((string) $index, 10, 36);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIndexByCid()

ilCtrlStructureCidGenerator::getIndexByCid

(

string

$cid

)

Returns the index of a given cid.

Parameters

string

$cid

Returns

int

Definition at line 35 of file class.ilCtrlStructureCidGenerator.php.

References ILIAS\Repository\int(), and invertIndex().

                                              : int
    {
        if (strpos($cid, '-') === 0) {
            $inverted_cid = str_replace('-', '', $cid);
            $index = (int) base_convert($inverted_cid, 36, 10);

            return $this->invertIndex($index);
        }

        return (int) base_convert($cid, 36, 10);
    }

Here is the call graph for this function:

invertIndex()

ilCtrlStructureCidGenerator::invertIndex ( int  $index )

private

Helper function that inverts an integer value.

Parameters

int

$index

Returns

int

Definition at line 78 of file class.ilCtrlStructureCidGenerator.php.

Referenced by getCidByIndex(), and getIndexByCid().

                                            : int
    {
        return (-1 * $index);
    }

Here is the caller graph for this function:

Field Documentation

$index

int ilCtrlStructureCidGenerator::$index

private

Definition at line 17 of file class.ilCtrlStructureCidGenerator.php.

---

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

• components/ILIAS/UICore/classes/Structure/class.ilCtrlStructureCidGenerator.php