ilBuddySystemRelationStateFactory Class Reference

Class ilBuddySystemRelationStateFactory. More...

Collaboration diagram for ilBuddySystemRelationStateFactory:

Public Member Functions
	getInitialState ()
	getStatesAsOptionArray ($with_initial_state=false)
	getRendererByOwnerAndRelation ($owner_id, ilBuddySystemRelation $relation)

Static Public Member Functions
static	getInstance ()

Protected Member Functions
	__construct ()

Protected Attributes
	$lng

Static Protected Attributes
static	$instance
static	$valid_states
static	$state_option_array

Detailed Description

Class ilBuddySystemRelationStateFactory.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 10 of file class.ilBuddySystemRelationStateFactory.php.

Constructor & Destructor Documentation

__construct()

ilBuddySystemRelationStateFactory::__construct ( )

protected

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

References $DIC.

    {
        global $DIC;

        $this->lng = $DIC['lng'];
    }

Member Function Documentation

getInitialState()

ilBuddySystemRelationStateFactory::getInitialState

(

)

Returns

ilBuddySystemRelationState

Exceptions

ilBuddySystemException

Definition at line 92 of file class.ilBuddySystemRelationStateFactory.php.

References $state.

    {
        foreach ($this->getValidStates() as $state) {
            if ($state->isInitial()) {
                return $state;
            }
        }

        throw new ilBuddySystemException("Could not find an initial state class");
    }

getInstance()

static ilBuddySystemRelationStateFactory::getInstance ( )

static

Returns

self

Definition at line 45 of file class.ilBuddySystemRelationStateFactory.php.

Referenced by ilBuddySystemGUI\__construct(), ilBuddySystemLinkButton\getHtml(), ilBuddyList\getRelationByUserId(), and ilBuddySystemRelationsTableGUI\initFilter().

    {
        if (null === self::$instance) {
            self::$instance = new self;
        }

        return self::$instance;
    }

Here is the caller graph for this function:

getRendererByOwnerAndRelation()

ilBuddySystemRelationStateFactory::getRendererByOwnerAndRelation	(		$owner_id,
		ilBuddySystemRelation	$relation
	)

Parameters

int	$owner_id
ilBuddySystemRelation	$relation

Returns

ilBuddySystemRelationStateButtonRenderer

Exceptions

ilBuddySystemException

Definition at line 130 of file class.ilBuddySystemRelationStateFactory.php.

References ilBuddySystemRelation\getState().

    {
        $state_class = get_class($relation->getState());
        $renderer_class = $state_class . 'ButtonRenderer';
        $renderer_path = "Services/Contact/BuddySystem/classes/states/renderer/class.{$renderer_class}.php";

        if (!file_exists($renderer_path)) {
            throw new ilBuddySystemException(sprintf("Could not find a renderer file for state: %s", $state_class));
        }

        require_once $renderer_path;
        if (!class_exists($renderer_class)) {
            throw new ilBuddySystemException(sprintf("Could not find a renderer class for state: %s in file: %s", $state_class, $renderer_path));
        }

        return new $renderer_class($owner_id, $relation);
    }

Here is the call graph for this function:

getStatesAsOptionArray()

ilBuddySystemRelationStateFactory::getStatesAsOptionArray

(

$with_initial_state = false

)

Parameters

bool

$with_initial_state

Returns

array

Definition at line 107 of file class.ilBuddySystemRelationStateFactory.php.

References PHPMailer\PHPMailer\$options, and $state.

    {
        if (null !== self::$state_option_array[$with_initial_state]) {
            return self::$state_option_array[$with_initial_state];
        }

        $options = array();

        foreach ($this->getValidStates() as $state) {
            if ($with_initial_state || !$state->isInitial()) {
                $options[get_class($state)] = $this->lng->txt('buddy_bs_state_' . strtolower($state->getName()));
            }
        }

        return (self::$state_option_array[$with_initial_state] = $options);
    }

Field Documentation

$instance

ilBuddySystemRelationStateFactory::$instance

staticprotected

Definition at line 15 of file class.ilBuddySystemRelationStateFactory.php.

$lng

ilBuddySystemRelationStateFactory::$lng

protected

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

$state_option_array

ilBuddySystemRelationStateFactory::$state_option_array

staticprotected

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

$valid_states

ilBuddySystemRelationStateFactory::$valid_states

staticprotected

Definition at line 20 of file class.ilBuddySystemRelationStateFactory.php.

---

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

• Services/Contact/BuddySystem/classes/states/class.ilBuddySystemRelationStateFactory.php