SectionEvent::__doit()

Complexity

Conditions	20
Paths	106

Size

Total Lines	110
Code Lines	54

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
    public function __doit(array $fields = array(), XMLElement &$result, $position = null, $entry_id = null)

Incorrect spacing between argument "$fields" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$fields"; expected 0 but found 1

Parameters which have default values should be placed at the end.

Incorrect spacing between argument "$position" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$position"; expected 0 but found 1

Incorrect spacing between argument "$entry_id" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$entry_id"; expected 0 but found 1

    {
        $post_values = new XMLElement('post-values');

        if (!is_array($this->eParamFILTERS)) {
            $this->eParamFILTERS = array();

The property eParamFILTERS does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }

        // Check to see if the Section of this Event is valid.
        if (!$section = SectionManager::fetch($this->getSource())) {

The method getSource() does not exist on SectionEvent.

            $result->setAttribute('result', 'error');
            $result->appendChild(new XMLElement('message', __('The Section, %s, could not be found.', array($this->getSource())), array(
                'message-id' => EventMessages::SECTION_MISSING
            )));
            return false;

The expression return false returns the type false which is incompatible with the documented return type XMLElement.

        }

        // Create the post data element
        if (!empty($fields)) {
            General::array_to_xml($post_values, $fields, true);
        }

        // If the EventPreSaveFilter fails, return early
        if ($this->processPreSaveFilters($result, $fields, $post_values, $entry_id) === false) {
            return false;

The expression return false returns the type false which is incompatible with the documented return type XMLElement.

        }

        // If the `$entry_id` is provided, check to see if it exists.
        // @todo If this was moved above PreSaveFilters, we can pass the
        // Entry object to the delegate meaning extensions don't have to
        // do that step.
        if (isset($entry_id)) {
            $entry = EntryManager::fetch($entry_id);
            $entry = $entry[0];

            if (!is_object($entry)) {
                $result->setAttribute('result', 'error');
                $result->appendChild(new XMLElement('message', __('The Entry, %s, could not be found.', array($entry_id)), array(
                    'message-id' => EventMessages::ENTRY_MISSING
                )));

                return false;

The expression return false returns the type false which is incompatible with the documented return type XMLElement.

            }

            // `$entry_id` wasn't provided, create a new Entry object.
        } else {
            $entry = EntryManager::create();
            $entry->set('section_id', $this->getSource());
        }

        // Validate the data. `$entry->checkPostData` loops over all fields calling
        // their `checkPostFieldData` function. If the return of the function is
        // `Entry::__ENTRY_FIELD_ERROR__` then abort the event and add the error
        // messages to the `$result`.
        if (Entry::__ENTRY_FIELD_ERROR__ == $entry->checkPostData($fields, $errors, ($entry->get('id') ? true : false))) {
            $result = self::appendErrors($result, $fields, $errors, $post_values);
            return false;

The expression return false returns the type false which is incompatible with the documented return type XMLElement.

            // If the data is good, process the data, almost ready to save it to the
            // Database. If processing fails, abort the event and display the errors
        } elseif (Entry::__ENTRY_OK__ != $entry->setDataFromPost($fields, $errors, false, ($entry->get('id') ? true : false))) {
            $result = self::appendErrors($result, $fields, $errors, $post_values);
            return false;

The expression return false returns the type false which is incompatible with the documented return type XMLElement.

            // Data is checked, data has been processed, by trying to save the
            // Entry caused an error to occur, so abort and return.
        } elseif ($entry->commit() === false) {
            $result->setAttribute('result', 'error');
            $result->appendChild(new XMLElement('message', __('Unknown errors where encountered when saving.'), array(
                'message-id' => EventMessages::ENTRY_UNKNOWN

The constant EventMessages::ENTRY_UNKNOWN was not found. Maybe you did not declare it correctly or list all dependencies?

            )));

            if (isset($post_values) && is_object($post_values)) {
                $result->appendChild($post_values);
            }

            return false;

The expression return false returns the type false which is incompatible with the documented return type XMLElement.

            // Entry was created, add the good news to the return `$result`
        } else {
            $result->setAttributeArray(array(
                'result' => 'success',
                'type' => (isset($entry_id) ? 'edited' : 'created'),
                'id' => $entry->get('id')
            ));

            if (isset($entry_id)) {
                $result->appendChild(new XMLElement('message', __('Entry edited successfully.'), array(
                    'message-id' => EventMessages::ENTRY_EDITED_SUCCESS
                )));
            } else {
                $result->appendChild(new XMLElement('message', __('Entry created successfully.'), array(
                    'message-id' => EventMessages::ENTRY_CREATED_SUCCESS
                )));
            }
        }

        // PASSIVE FILTERS ONLY AT THIS STAGE. ENTRY HAS ALREADY BEEN CREATED.
        if (in_array('send-email', $this->eParamFILTERS) && !in_array('expect-multiple', $this->eParamFILTERS)) {
            $result = $this->processSendMailFilter($result, $_POST['send-email'], $fields, $section, $entry);

It seems like $section can also be of type array; however, parameter $section of SectionEvent::processSendMailFilter() does only seem to accept Section, maybe add an additional type check?

        }

        $result = $this->processPostSaveFilters($result, $fields, $entry);
        $result = $this->processFinalSaveFilters($result, $fields, $entry);

        if (isset($post_values) && is_object($post_values)) {
            $result->appendChild($post_values);
        }

        return true;

The expression return true returns the type true which is incompatible with the documented return type XMLElement.

    }