MetaFox

LocationScope extends BaseScope
in package

Class LocationScope.

Table of Contents

Constants

DEFAULT_COUNTRY_FIELD  = 'country_iso'

Properties

$city  : string|null
$cityField  : string|null
$country  : string|null
$countryField  : string|null
$state  : string|null
$stateField  : string|null
$table  : string|null

Methods

apply()  : mixed
applyQueryBuilder()  : void
getCity()  : string|null
getCityField()  : string|null
getCountry()  : string|null
getCountryField()  : string|null
getState()  : string|null
getStateField()  : string|null
getTable()  : string|null
likeOperator()  : string
return the case-insensitive LIKE operator bases on the current database driver.
setCity()  : void
setCityField()  : void
setCountry()  : $this
setCountryField()  : $this
setState()  : void
setStateField()  : void
setTable()  : $this
alias()  : string
buildCityCondition()  : mixed
buildCountryCondition()  : mixed
buildStateCondition()  : mixed

Constants

DEFAULT_COUNTRY_FIELD

public mixed DEFAULT_COUNTRY_FIELD = 'country_iso'

Properties

Methods

apply()

public apply(Builder $builder, Model $model) : mixed
Parameters
$builder : Builder
$model : Model
Tags
SuppressWarnings

(PHPMD.CyclomaticComplexity)

SuppressWarnings

(PHPMD.UnusedFormalParameter)

applyQueryBuilder()

public applyQueryBuilder(Builder $builder) : void
Parameters
$builder : Builder

getCity()

public getCity() : string|null
Return values
string|null

getCityField()

public getCityField() : string|null
Return values
string|null

getCountry()

public getCountry() : string|null
Return values
string|null

getCountryField()

public getCountryField() : string|null
Return values
string|null

getState()

public getState() : string|null
Return values
string|null

getStateField()

public getStateField() : string|null
Return values
string|null

getTable()

public getTable() : string|null
Return values
string|null

likeOperator()

return the case-insensitive LIKE operator bases on the current database driver.

public likeOperator() : string
Return values
string

setCity()

public setCity(string|null $city) : void
Parameters
$city : string|null

setCityField()

public setCityField(string|null $cityField) : void
Parameters
$cityField : string|null

setCountry()

public setCountry(string|null $country) : $this
Parameters
$country : string|null
Return values
$this

setCountryField()

public setCountryField(string|null $field) : $this
Parameters
$field : string|null
Return values
$this

setState()

public setState(string|null $state) : void
Parameters
$state : string|null

setStateField()

public setStateField(string|null $stateField) : void
Parameters
$stateField : string|null

setTable()

public setTable(string $table) : $this
Parameters
$table : string
Return values
$this

alias()

protected alias(string $table, string $column) : string
Parameters
$table : string
$column : string
Return values
string

buildCityCondition()

protected buildCityCondition(Builder $builder, string $table) : mixed
Parameters
$builder : Builder
$table : string

buildCountryCondition()

protected buildCountryCondition(Builder $builder, string $table) : mixed
Parameters
$builder : Builder
$table : string

buildStateCondition()

protected buildStateCondition(Builder $builder, string $table) : mixed
Parameters
$builder : Builder
$table : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results