Webiny\Component\StdLib\StdObject\UrlObject\UrlObject::getScheme PHP Method

getScheme() public method

Get scheme (eg. http).
public getScheme ( ) : boolean | string
return boolean | string Url scheme, or false if it's not set.
    public function getScheme()
    {
        return $this->scheme;
    }

Usage Example

Example #1
0
 /**
  * This method tries to match the given url against the route collection.
  * If match is successful, an array with callback and params is returned.
  * If match is not successful, false is returned.
  *
  * @param UrlObject $url
  *
  * @return array|bool
  */
 public function match(UrlObject $url)
 {
     $pathWithHost = $this->str($url->getHost() . $url->getPath())->trimRight('/')->val();
     $pathWithoutHost = $this->str($url->getPath())->trimRight('/')->val();
     /**
      * @var Route $route
      */
     foreach (Router::getRouteCollection()->all() as $name => $route) {
         $compiledRoute = $route->compile();
         // 1. Make sure staticPrefix and path both contain leading slash
         $staticPrefix = $compiledRoute->getStaticPrefix();
         $staticPrefix = $staticPrefix != '' && !$this->str($staticPrefix)->startsWith('/') ? '/' . $staticPrefix : $staticPrefix;
         $urlPath = $this->str($url->getPath())->startsWith('/') ? $url->getPath() : '/' . $url->getPath();
         // 2. First check the static prefix on path because we don't want to use heavy preg_matching if the prefix doesn't match
         if ($staticPrefix != '' && strpos($urlPath, $staticPrefix) !== 0) {
             continue;
         }
         // let's check the host
         if ($route->getHost() != '' && $route->getHost() != $url->getHost()) {
             continue;
         }
         // let's check schemes
         if (count($route->getSchemes()) > 0 && !in_array($url->getScheme(), $route->getSchemes())) {
             continue;
         }
         // let's check them methods
         if (count($route->getMethods()) > 0 && !in_array($this->request()->server()->requestMethod(), $route->getMethods())) {
             continue;
         }
         // check if we need to match the host also
         if ($route->getHost() != '') {
             $fullPath = $pathWithHost;
         } else {
             $fullPath = $pathWithoutHost;
         }
         // 3. Check the root path
         if ($route->getPath() == '' && ($url->getPath() != '/' && $url->getPath() != '')) {
             continue;
         }
         if (!$compiledRoute->getRegex()) {
             if ($fullPath != '') {
                 continue;
             }
             // if there is no regex, that means we can only match an empty path
             $params = [];
         } else {
             // finally let's try to match the full url
             preg_match_all($compiledRoute->getRegex(), $fullPath, $matches);
             if (count($matches[0]) < 1) {
                 // if we haven't matched the url, lets see if we have all the default values for every pattern,
                 // because if we do, and since the static prefix has been matched, we can still consider the url to be
                 // matched
                 if ($compiledRoute->getDefaultRoute()) {
                     preg_match_all($compiledRoute->getRegex(), $compiledRoute->getDefaultRoute(), $matches);
                     if (count($matches[0]) < 1) {
                         continue;
                     }
                 } else {
                     continue;
                 }
             }
             // if we matched the route, we need to extract the parameters
             $params = $this->extractParameters($matches, $compiledRoute);
         }
         return new MatchedRoute($route, $params);
     }
     return false;
 }
All Usage Examples Of Webiny\Component\StdLib\StdObject\UrlObject\UrlObject::getScheme