ilECSCourseAttributes Class Reference

Storage of course attributes for assignment rules. More...

Collaboration diagram for ilECSCourseAttributes:

Public Member Functions
	__construct (int $a_server_id, int $a_mid)
	Constructor. More...
	getAttributes ()
	Get current attributes. More...
	getFirstAttribute ()
	Get first defined attribute. More...
	getFirstAttributeName ()
	Get first attribute name. More...
	getAttributeSequence ($a_last_attribute)
	Get attribute sequence. More...
	getUpperAttributes ($a_name)
	Get upper attributes in hierarchy. More...
	getNextAttributeName (string $a_name)
	Get next attribute name in sequence. More...
	getPreviousAttributeName (string $a_name)
	Get next attribute name in sequence. More...
	getAttributeValues ()
	Get active attribute values. More...
	delete ()
	Delete all mappings. More...

Static Public Member Functions
static	getInstance (int $a_server_id, int $a_mid)
	Get instance. More...

Protected Member Functions
	read ()
	Read attributes. More...

Private Attributes
int	$server_id
int	$mid
array	$attributes = array()
ilDBInterface	$db

Static Private Attributes
static array	$instances = null

Detailed Description

Storage of course attributes for assignment rules.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 25 of file class.ilECSCourseAttributes.php.

Constructor & Destructor Documentation

__construct()

ilECSCourseAttributes::__construct	(	int	$a_server_id,
		int	$a_mid
	)

Constructor.

Definition at line 39 of file class.ilECSCourseAttributes.php.

References $DIC, and read().

    {
        global $DIC;

        $this->db = $DIC->database();

        $this->server_id = $a_server_id;
        $this->mid = $a_mid;

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ilECSCourseAttributes::delete

(

)

Delete all mappings.

Definition at line 184 of file class.ilECSCourseAttributes.php.

References getAttributes().

                            : void
    {
        foreach ($this->getAttributes() as $att) {
            $att->delete();
        }
        $this->attributes = [];
    }

Here is the call graph for this function:

getAttributes()

ilECSCourseAttributes::getAttributes

(

)

Get current attributes.

Definition at line 63 of file class.ilECSCourseAttributes.php.

References $attributes.

Referenced by delete(), getAttributeSequence(), getAttributeValues(), getFirstAttribute(), getNextAttributeName(), getPreviousAttributeName(), and getUpperAttributes().

                                   : array
    {
        return $this->attributes;
    }

Here is the caller graph for this function:

getAttributeSequence()

ilECSCourseAttributes::getAttributeSequence

(

$a_last_attribute

)

Get attribute sequence.

Definition at line 90 of file class.ilECSCourseAttributes.php.

References getAttributes().

                                                           : array
    {
        if (!$a_last_attribute) {
            return [];
        }
        $sequence = [];
        foreach ($this->getAttributes() as $att) {
            $sequence[] = $att->getName();
            if ($a_last_attribute === $att->getName()) {
                break;
            }
        }
        return $sequence;
    }

Here is the call graph for this function:

getAttributeValues()

ilECSCourseAttributes::getAttributeValues

(

)

Get active attribute values.

Definition at line 172 of file class.ilECSCourseAttributes.php.

References getAttributes().

                                        : array
    {
        $values = array();
        foreach ($this->getAttributes() as $att) {
            $values[] = $att->getName();
        }
        return $values;
    }

Here is the call graph for this function:

getFirstAttribute()

ilECSCourseAttributes::getFirstAttribute

(

)

Get first defined attribute.

Definition at line 71 of file class.ilECSCourseAttributes.php.

References getAttributes().

Referenced by getFirstAttributeName().

                                       : ?\ilECSCourseAttribute
    {
        return $this->getAttributes()[0] ?? null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFirstAttributeName()

ilECSCourseAttributes::getFirstAttributeName

(

)

Get first attribute name.

Definition at line 79 of file class.ilECSCourseAttributes.php.

References getFirstAttribute().

Referenced by getNextAttributeName().

                                           : string
    {
        if ($this->getFirstAttribute() instanceof ilECSCourseAttribute) {
            return $this->getFirstAttribute()->getName();
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static ilECSCourseAttributes::getInstance ( int  $a_server_id, int  $a_mid  )

static

Get instance.

Definition at line 54 of file class.ilECSCourseAttributes.php.

References $id.

Referenced by ilECSMappingSettingsGUI\cAddAttribute(), ilECSMappingSettingsGUI\cDeleteAttribute(), ilECSMappingSettingsGUI\cInitMappingForm(), and ilECSMappingSettingsGUI\initFormCSettings().

                                                                    : \ilECSCourseAttributes
    {
        $id = $a_server_id . '_' . $a_mid;
        return self::$instances[$id] ?? (self::$instances[$id] = new ilECSCourseAttributes($a_server_id, $a_mid));
    }

Here is the caller graph for this function:

getNextAttributeName()

ilECSCourseAttributes::getNextAttributeName

(

string

$a_name

)

Get next attribute name in sequence.

Definition at line 129 of file class.ilECSCourseAttributes.php.

References getAttributes(), and getFirstAttributeName().

                                                        : string
    {
        if (!$a_name) {
            return $this->getFirstAttributeName();
        }
        $found = false;
        foreach ($this->getAttributes() as $att) {
            if ($a_name === $att->getName()) {
                $found = true;
                continue;
            }
            if ($found) {
                return $att->getName();
            }
        }
        return '';
    }

Here is the call graph for this function:

getPreviousAttributeName()

ilECSCourseAttributes::getPreviousAttributeName

(

string

$a_name

)

Get next attribute name in sequence.

Definition at line 150 of file class.ilECSCourseAttributes.php.

References getAttributes().

                                                            : string
    {
        if (!$a_name) {
            return '';
        }
        $found = false;
        $reverse_attributes = array_reverse($this->getAttributes());
        foreach ($reverse_attributes as $att) {
            if ($a_name === $att->getName()) {
                $found = true;
                continue;
            }
            if ($found) {
                return $att->getName();
            }
        }
        return '';
    }

Here is the call graph for this function:

getUpperAttributes()

ilECSCourseAttributes::getUpperAttributes

(

$a_name

)

Get upper attributes in hierarchy.

Definition at line 108 of file class.ilECSCourseAttributes.php.

References getAttributes().

                                               : array
    {
        $reverse_attributes = array_reverse($this->getAttributes());

        $found = false;
        $upper = array();
        foreach ($reverse_attributes as $att) {
            if ($att->getName() === $a_name) {
                $found = true;
                continue;
            }
            if ($found) {
                $upper[] = $att->getName();
            }
        }
        return array_reverse($upper);
    }

Here is the call graph for this function:

read()

ilECSCourseAttributes::read ( )

protected

Read attributes.

Definition at line 196 of file class.ilECSCourseAttributes.php.

References $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by __construct().

                             : void
    {
        $this->attributes = [];

        $query = 'SELECT * FROM ecs_crs_mapping_atts ' .
                'WHERE sid = ' . $this->db->quote($this->server_id, 'integer') . ' ' .
                'AND mid = ' . $this->db->quote($this->mid, 'integer') . ' ' .
                'ORDER BY id';
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->attributes[] = new ilECSCourseAttribute((int) $row->id);
        }
    }

Here is the caller graph for this function:

Field Documentation

$attributes

array ilECSCourseAttributes::$attributes = array()

private

Definition at line 32 of file class.ilECSCourseAttributes.php.

Referenced by getAttributes().

$db

ilDBInterface ilECSCourseAttributes::$db

private

Definition at line 34 of file class.ilECSCourseAttributes.php.

$instances

array ilECSCourseAttributes::$instances = null

staticprivate

Definition at line 27 of file class.ilECSCourseAttributes.php.

$mid

int ilECSCourseAttributes::$mid

private

Definition at line 30 of file class.ilECSCourseAttributes.php.

$server_id

int ilECSCourseAttributes::$server_id

private

Definition at line 29 of file class.ilECSCourseAttributes.php.

---

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

• Services/WebServices/ECS/classes/Course/class.ilECSCourseAttributes.php