App\Http\Controllers\LocationsController Class Reference

This controller handles all actions related to Locations for the Snipe-IT Asset Management application. More...

Inheritance diagram for App\Http\Controllers\LocationsController:

Public Member Functions
	getIndex ()
	Returns a view that invokes the ajax tables which actually contains the content for the locations listing, which is generated in getDatatable. More...
	getCreate ()
	Returns a form view used to create a new location. More...
	postCreate ()
	Validates and stores a new location. More...
	store ()
	Validates and stores a new location created via the Create Asset form modal. More...
	getEdit ($locationId=null)
	Makes a form view to edit location information. More...
	postEdit ($locationId=null)
	Validates and stores updated location data from edit form. More...
	getDelete ($locationId)
	Validates and deletes selected location. More...
	getView ($locationId=null)
	Returns a view that invokes the ajax tables which actually contains the content for the locations detail page. More...
	getDatatable ()
	Returns the JSON response to populate the bootstrap tables on the locationa view. More...
	getDataViewUsers ($locationID)
	Returns a JSON response that contains the users association with the selected location, to be used by the location detail view. More...
	getDataViewAssets ($locationID)
	Returns a JSON response that contains the assets association with the selected location, to be used by the location detail view. More...

Detailed Description

This controller handles all actions related to Locations for the Snipe-IT Asset Management application.

Version

v1.0

Definition at line 22 of file LocationsController.php.

Member Function Documentation

App\Http\Controllers\LocationsController::getCreate

(

)

Returns a form view used to create a new location.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

LocationsController::postCreate() method that validates and stores the data

Since

[v1.0]

Returns

View

Definition at line 52 of file LocationsController.php.

    {
        $locations = Location::orderBy('name', 'ASC')->get();

        $location_options_array = Location::getLocationHierarchy($locations);
        $location_options = Location::flattenLocationsArray($location_options_array);
        $location_options = array('' => 'Top Level') + $location_options;

        return View::make('locations/edit')
        ->with('location_options', $location_options)
        ->with('location', new Location);
    }

App\Http\Controllers\LocationsController::getDatatable

(

)

Returns the JSON response to populate the bootstrap tables on the locationa view.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

LocationsController::getIndex() method that returns JSON for location index

Since

[v1.0]

Returns

View

Definition at line 289 of file LocationsController.php.

    {
        $locations = Location::select(array('locations.id','locations.name','locations.address','locations.address2','locations.city','locations.state','locations.zip','locations.country','locations.parent_id','locations.currency'))->with('assets');


        if (Input::has('search')) {
            $locations = $locations->TextSearch(e(Input::get('search')));
        }

        if (Input::has('offset')) {
            $offset = e(Input::get('offset'));
        } else {
            $offset = 0;
        }

        if (Input::has('limit')) {
            $limit = e(Input::get('limit'));
        } else {
            $limit = 50;
        }

        $order = Input::get('order') === 'asc' ? 'asc' : 'desc';



        switch (Input::get('sort')) {
            case 'parent':
                $locations = $locations->OrderParent($order);
                break;
            default:
                $allowed_columns = ['id','name','address','city','state','country','currency'];

                $sort = in_array(Input::get('sort'), $allowed_columns) ? Input::get('sort') : 'created_at';
                $locations = $locations->orderBy($sort, $order);
                break;
        }


        $locationsCount = $locations->count();
        $locations = $locations->skip($offset)->take($limit)->get();

        $rows = array();

        foreach ($locations as $location) {
            $actions = '<nobr><a href="'.route('update/location', $location->id).'" class="btn btn-warning btn-sm" style="margin-right:5px;"><i class="fa fa-pencil icon-white"></i></a><a data-html="false" class="btn delete-asset btn-danger btn-sm" data-toggle="modal" href="'.route('delete/location', $location->id).'" data-content="'.trans('admin/locations/message.delete.confirm').'" data-title="'.trans('general.delete').' '.htmlspecialchars($location->name).'?" onClick="return false;"><i class="fa fa-trash icon-white"></i></a></nobr>';

            $rows[] = array(
                'id'            => $location->id,
                'name'          => (string)link_to('admin/settings/locations/'.$location->id.'/view', e($location->name)),
                'parent'        => ($location->parent) ? e($location->parent->name) : '',
              //  'assets'        => ($location->assets->count() + $location->assignedassets->count()),
                'assets_default' => $location->assignedassets->count(),
                'assets_checkedout' => $location->assets->count(),
                'address'       => ($location->address) ? e($location->address): '',
                'city'          => e($location->city),
                'state'         => e($location->state),
                'country'       => e($location->country),
                'currency'      => e($location->currency),
                'actions'       => $actions
            );
        }

        $data = array('total' => $locationsCount, 'rows' => $rows);

        return $data;

    }

App\Http\Controllers\LocationsController::getDataViewAssets

(

$locationID

)

Returns a JSON response that contains the assets association with the selected location, to be used by the location detail view.

Todo:

This is broken for accessories and consumables.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

LocationsController::getView() method that creates the display view

Parameters

int

$locationId

Since

[v1.8]

Returns

View

Definition at line 396 of file LocationsController.php.

    {
        $location = Location::find($locationID)->load('assignedassets.model');
        $rows = array();

        foreach ($location->assignedassets as $asset) {
            $rows[] = array(
            'name' => (string)link_to('/hardware/'.$asset->id.'/view', e($asset->showAssetName())),
            'asset_tag' => e($asset->asset_tag),
            'serial' => e($asset->serial),
            'model' => e($asset->model->name),
            );
        }

        $data = array('total' => $location->assignedassets->count(), 'rows' => $rows);
        return $data;

    }

App\Http\Controllers\LocationsController::getDataViewUsers

(

$locationID

)

Returns a JSON response that contains the users association with the selected location, to be used by the location detail view.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

LocationsController::getView() method that creates the display view

Parameters

int

$locationId

Since

[v1.8]

Returns

View

Definition at line 368 of file LocationsController.php.

    {
        $location = Location::find($locationID);
        $rows = array();

        foreach ($location->users as $user) {
            $rows[] = array(
              'name' => (string)link_to('/admin/users/'.$user->id.'/view', e($user->fullName()))
              );
        }

        $data = array('total' => $location->users->count(), 'rows' => $rows);

        return $data;
    }

App\Http\Controllers\LocationsController::getDelete

(

$locationId

)

Validates and deletes selected location.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

Parameters

int

$locationId

Since

[v1.0]

Returns

Redirect

Definition at line 225 of file LocationsController.php.

    {
        // Check if the location exists
        if (is_null($location = Location::find($locationId))) {
            // Redirect to the blogs management page
            return Redirect::to('admin/settings/locations')->with('error', trans('admin/locations/message.not_found'));
        }


        if ($location->users->count() > 0) {
            return Redirect::to('admin/settings/locations')->with('error', trans('admin/locations/message.assoc_users'));
        } elseif ($location->childLocations->count() > 0) {
            return Redirect::to('admin/settings/locations')->with('error', trans('admin/locations/message.assoc_child_loc'));
        } elseif ($location->assets->count() > 0) {
            return Redirect::to('admin/settings/locations')->with('error', trans('admin/locations/message.assoc_assets'));
        } elseif ($location->assignedassets->count() > 0) {
            return Redirect::to('admin/settings/locations')->with('error', trans('admin/locations/message.assoc_assets'));
        } else {
            $location->delete();
            return Redirect::to('admin/settings/locations')->with('success', trans('admin/locations/message.delete.success'));
        }



    }

App\Http\Controllers\LocationsController::getEdit

(

$locationId = null

)

Makes a form view to edit location information.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

LocationsController::postCreate() method that validates and stores

Parameters

int

$locationId

Since

[v1.0]

Returns

View

Definition at line 157 of file LocationsController.php.

    {
        // Check if the location exists
        if (is_null($location = Location::find($locationId))) {
            return Redirect::to('admin/settings/locations')->with('error', trans('admin/locations/message.does_not_exist'));
        }

        // Show the page
        $locations = Location::orderBy('name', 'ASC')->get();
        $location_options_array = Location::getLocationHierarchy($locations);
        $location_options = Location::flattenLocationsArray($location_options_array);
        $location_options = array('' => 'Top Level') + $location_options;

        return View::make('locations/edit', compact('location'))->with('location_options', $location_options);
    }

App\Http\Controllers\LocationsController::getIndex

(

)

Returns a view that invokes the ajax tables which actually contains the content for the locations listing, which is generated in getDatatable.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

LocationsController::getDatatable() method that generates the JSON response

Since

[v1.0]

Returns

View

Definition at line 34 of file LocationsController.php.

    {
        // Grab all the locations
        $locations = Location::orderBy('created_at', 'DESC')->with('parent', 'assets', 'assignedassets')->get();

        // Show the page
        return View::make('locations/index', compact('locations'));
    }

App\Http\Controllers\LocationsController::getView

(

$locationId = null

)

Returns a view that invokes the ajax tables which actually contains the content for the locations detail page.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

LocationsController::getDataViewUsers() method that returns JSON for location users

LocationsController::getDataViewAssets() method that returns JSON for location assets

Parameters

int

$locationId

Since

[v1.0]

Returns

View

Definition at line 263 of file LocationsController.php.

    {
        $location = Location::find($locationId);

        if (isset($location->id)) {
                return View::make('locations/view', compact('location'));
        } else {
            // Prepare the error message
            $error = trans('admin/locations/message.does_not_exist', compact('id'));

            // Redirect to the user management page
            return Redirect::route('locations')->with('error', $error);
        }


    }

App\Http\Controllers\LocationsController::postCreate

(

)

Validates and stores a new location.

Todo:

Check if a Form Request would work better here.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

LocationsController::getCreate() method that makes the form

Since

[v1.0]

Returns

Redirect

Definition at line 75 of file LocationsController.php.

    {

    // create a new location instance
        $location = new Location();


    // Save the location data
        $location->name             = e(Input::get('name'));
        if (Input::get('parent_id')=='') {
            $location->parent_id        = null;
        } else {
            $location->parent_id        = e(Input::get('parent_id'));
        }
        $location->currency             = e(Input::get('currency', '$'));
        $location->address          = e(Input::get('address'));
        $location->address2             = e(Input::get('address2'));
        $location->city             = e(Input::get('city'));
        $location->state            = e(Input::get('state'));
        $location->country          = e(Input::get('country'));
        $location->zip              = e(Input::get('zip'));
        $location->user_id          = Auth::user()->id;

        if ($location->save()) {
            // Redirect to the new location  page
            return Redirect::to("admin/settings/locations")->with('success', trans('admin/locations/message.create.success'));
        }

        return Redirect::back()->withInput()->withErrors($location->getErrors());

    }

App\Http\Controllers\LocationsController::postEdit

(

$locationId = null

)

Validates and stores updated location data from edit form.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

LocationsController::getEdit() method that makes the form view

Parameters

int

$locationId

Since

[v1.0]

Returns

Redirect

Definition at line 183 of file LocationsController.php.

    {
        // Check if the location exists
        if (is_null($location = Location::find($locationId))) {
            // Redirect to the blogs management page
            return Redirect::to('admin/settings/locations')->with('error', trans('admin/locations/message.does_not_exist'));
        }

        // Update the location data
        $location->name         = e(Input::get('name'));
        if (Input::get('parent_id')=='') {
            $location->parent_id        = null;
        } else {
            $location->parent_id        = e(Input::get('parent_id', ''));
        }
        $location->currency             = e(Input::get('currency', '$'));
        $location->address          = e(Input::get('address'));
        $location->address2             = e(Input::get('address2'));
        $location->city             = e(Input::get('city'));
        $location->state            = e(Input::get('state'));
        $location->country      = e(Input::get('country'));
        $location->zip            = e(Input::get('zip'));

        // Was the asset created?
        if ($location->save()) {
          // Redirect to the saved location page
            return Redirect::to("admin/settings/locations/")->with('success', trans('admin/locations/message.update.success'));
        }

        // Redirect to the location management page
        return Redirect::back()->withInput()->withInput()->withErrors($location->getErrors());

    }

App\Http\Controllers\LocationsController::store

(

)

Validates and stores a new location created via the Create Asset form modal.

Todo:

Check if a Form Request would work better here.

Author

[A. Gianotto] [snipe.nosp@m.@sni.nosp@m.pe.ne.nosp@m.t]

See also

AssetsController::getCreate() method that makes the form

Since

[v1.0]

Returns

String JSON

Definition at line 116 of file LocationsController.php.

    {

        $new['currency']=Setting::first()->default_currency;

        // create a new location instance
        $location = new Location();

        // Save the location data
        $location->name               = e(Input::get('name'));
        $location->currency           =  Setting::first()->default_currency; //e(Input::get('currency'));
        $location->address            = ''; //e(Input::get('address'));
        // $location->address2          = e(Input::get('address2'));
        $location->city               = e(Input::get('city'));
        $location->state          = '';//e(Input::get('state'));
        $location->country            = e(Input::get('country'));
        // $location->zip               = e(Input::get('zip'));
        $location->user_id          = Auth::user()->id;

        // Was the location created?
        if ($location->save()) {
            return JsonResponse::create($location);

        }

        // failure
        $errors = $location->errors();
        return JsonResponse::create(["error" => "Failed validation: ".print_r($location->getErrors(), true)], 500);

    }

---

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

• LocationsController.php