klein.php 다운로드 - klein.php 소스 코드 다운로드

클라인.php

klein.php 는 PHP 5.3 이상을 위한 빠르고 유연한 라우터입니다.

유연한 정규식 라우팅(Sinatra에서 영감을 받음)
웹 앱을 빠르게 구축하기 위한 일련의 상용구 방법
오버헤드가 거의 없음 => 초당 2500개 이상의 요청

시작하기

PHP 5.3.x가 필요합니다
Composer를 사용하여(권장) 또는 수동으로 Klein 설치
모든 요청이 index.php 에 의해 처리되도록 URL 재작성을 설정하세요.
(선택 사항) 좋은 측정을 위해 일부 APC를 추가합니다.

작곡가 설치

작곡가 받기
php composer.phar require klein/klein
애플리케이션의 기본 PHP 파일에 다음을 추가합니다: require 'vendor/autoload.php';

예

Hello World - 필수 Hello World 예제

 <?php
require_once __DIR__ . ' /vendor/autoload.php ' ;

$ klein = new  Klein  Klein ();

$ klein -> respond ( ' GET ' , ' /hello-world ' , function () {
    return ' Hello World! ' ;
});

$ klein -> dispatch ();

예시 1 - 모든 요청에 응답

 $ klein -> respond ( function () {
    return ' All the things ' ;
});

예 2 - 명명된 매개변수

 $ klein -> respond ( ' /[:name] ' , function ( $ request ) {
    return ' Hello ' . $ request -> name ;
});

예 3 - 매우 RESTful

 $ klein -> respond ( ' GET ' , ' /posts ' , $ callback );
$ klein -> respond ( ' POST ' , ' /posts ' , $ callback );
$ klein -> respond ( ' PUT ' , ' /posts/[i:id] ' , $ callback );
$ klein -> respond ( ' DELETE ' , ' /posts/[i:id] ' , $ callback );
$ klein -> respond ( ' OPTIONS ' , null , $ callback );

// To match multiple request methods:
$ klein -> respond ( array ( ' POST ' , ' GET ' ), $ route , $ callback );

// Or you might want to handle the requests in the same place
$ klein -> respond ( ' /posts/[create|edit:action]?/[i:id]? ' , function ( $ request , $ response ) {
    switch ( $ request -> action ) {
        //
    }
});

예시 4 - 개체/파일 보내기

 $ klein ->respond( function ( $ request , $ response , $ service ) {
    $ service -> xml = function ( $ object ) {
        // Custom xml output function
    }
    $ service -> csv = function ( $ object ) {
        // Custom csv output function
    }
});

$ klein -> respond ( ' /report.[xml|csv|json:format]? ' , function ( $ request , $ response , $ service ) {
    // Get the format or fallback to JSON as the default
    $ send = $ request -> param ( ' format ' , ' json ' );
    $ response -> $ send ( $ report );
});

$ klein -> respond ( ' /report/latest ' , function ( $ request , $ response , $ service ) {
    $ response -> file ( ' /tmp/cached_report.zip ' );
});

예시 5 - 모두 함께

 $ klein -> respond ( function ( $ request , $ response , $ service , $ app ) use ( $ klein ) {
    // Handle exceptions => flash the message and redirect to the referrer
    $ klein -> onError ( function ( $ klein , $ err_msg ) {
        $ klein -> service ()-> flash ( $ err_msg );
        $ klein -> service ()-> back ();
    });

    // The fourth parameter can be used to share scope and global objects
    $ app -> db = new PDO (...);

    // $app also can store lazy services, e.g. if you don't want to
    // instantiate a database connection on every response
    $ app -> register ( ' db ' , function () {
        return new PDO (...);
    });
});

$ klein -> respond ( ' POST ' , ' /users/[i:id]/edit ' , function ( $ request , $ response , $ service , $ app ) {
    // Quickly validate input parameters
    $ service -> validateParam ( ' username ' , ' Please enter a valid username ' )-> isLen ( 5 , 64 )-> isChars ( ' a-zA-Z0-9- ' );
    $ service -> validateParam ( ' password ' )-> notNull ();

    $ app -> db -> query (...); // etc.

    // Add view properties and helper methods
    $ service -> title = ' foo ' ;
    $ service -> escape = function ( $ str ) {
        return htmlentities ( $ str ); // Assign view helpers
    };

    $ service -> render ( ' myview.phtml ' );
});

// myview.phtml:
<title> <?php echo $ this -> escape ( $ this -> title ) ?> </title>

경로 네임스페이스

 $ klein -> with ( ' /users ' , function () use ( $ klein ) {

    $ klein -> respond ( ' GET ' , ' /? ' , function ( $ request , $ response ) {
        // Show all users
    });

    $ klein -> respond ( ' GET ' , ' /[:id] ' , function ( $ request , $ response ) {
        // Show a single user
    });

});

foreach ( array ( ' projects ' , ' posts ' ) as $ controller ) {
    // Include all routes defined in a file under a given namespace
    $ klein -> with ( " / $ controller " , " controllers/ $ controller .php " );
}

포함된 파일은 Klein( $klein ) 범위에서 실행되므로 $this 사용하여 모든 Klein 메서드/속성에 액세스할 수 있습니다.

예시 파일: "controllers/projects.php"

 // Routes to "/projects/?"
$ this -> respond ( ' GET ' , ' /? ' , function ( $ request , $ response ) {
    // Show all projects
});

게으른 서비스

서비스는 느리게 저장될 수 있습니다. 즉, 처음 사용할 때만 인스턴스화됩니다.

 <?php
$ klein -> respond ( function ( $ request , $ response , $ service , $ app ) {
    $ app -> register ( ' lazyDb ' , function () {
        $ db = new stdClass ();
        $ db -> name = ' foo ' ;
        return $ db ;
    });
});

//Later

$ klein -> respond ( ' GET ' , ' /posts ' , function ( $ request , $ response , $ service , $ app ) {
    // $db is initialised on first request
    // all subsequent calls will use the same instance
    return $ app -> lazyDb -> name ;
});

검증인

사용자 정의 유효성 검사기를 추가하려면 addValidator($method, $callback) 사용하세요.

 $ service -> addValidator ( ' hex ' , function ( $ str ) {
    return preg_match ( ' /^[0-9a-f]++$/i ' , $ str );
});

is<$method>() 또는 not<$method>() 사용하여 매개변수의 유효성을 검사할 수 있습니다. 예:

 $ service -> validateParam ( ' key ' )-> isHex ();

또는 동일한 흐름을 사용하여 모든 문자열의 유효성을 검사할 수 있습니다.

 $ service -> validate ( $ username )-> isLen ( 4 , 16 );

유효성 검사 방법은 체인화 가능하며 유효성 검사가 실패하는 경우에 대한 사용자 정의 예외 메시지를 지정할 수 있습니다.

 $ service -> validateParam ( ' key ' , ' The key was invalid ' )-> isHex ()-> isLen ( 32 );

라우팅

[ match_type : 매개변수_이름 ]

몇 가지 예

 *                    // Match all request URIs
[i]                  // Match an integer
[i:id]               // Match an integer as 'id'
[a:action]           // Match alphanumeric characters as 'action'
[h:key]              // Match hexadecimal characters as 'key'
[:action]            // Match anything up to the next / or end of the URI as 'action'
[create|edit:action] // Match either 'create' or 'edit' as 'action'
[*]                  // Catch all (lazy)
[*:trailing]         // Catch all as 'trailing' (lazy)
[**:trailing]        // Catch all (possessive - will match the rest of the URI)
.[:format]?          // Match an optional parameter 'format' - a / or . before the block is also optional

좀 더 복잡한 예

 /posts/[*:title][i:id]     // Matches "/posts/this-is-a-title-123"
/output.[xml|json:format]? // Matches "/output", "output.xml", "output.json"
/[:controller]?/[:action]? // Matches the typical /controller/action format

참고 - 요청 URI와 일치하는 모든 경로가 호출됩니다. 이를 통해 사용자 인증이나 보기 레이아웃과 같은 복잡한 조건부 논리를 통합할 수 있습니다. 예를 들어 기본 예로서 다음 코드는 머리글과 바닥글로 다른 경로를 래핑합니다.

 $ klein -> respond ( ' * ' , function ( $ request , $ response , $ service ) { $ service -> render ( ' header.phtml ' ); });
//other routes
$ klein -> respond ( ' * ' , function ( $ request , $ response , $ service ) { $ service -> render ( ' footer.phtml ' ); });

경로는 전체 요청 URI와 자동으로 일치합니다. 요청 URI의 일부만 일치시키거나 사용자 정의 정규식을 사용해야 하는 경우 @ 연산자를 사용하십시오. 경로를 무효화해야 하는 경우 ! 연산자

 // Match all requests that end with '.json' or '.csv'
$ klein ->respond( ' @.(json|csv)$ ' , ...

// Match all requests that _don't_ start with /admin
$ klein ->respond( ' !@^/admin/ ' , ...

조회수

$service 객체에 할당하거나 $service->render() 의 두 번째 인수를 사용하여 속성이나 도우미를 뷰에 보낼 수 있습니다.

 $ service -> escape = function ( $ str ) {
    return htmlentities ( $ str );
};

$ service -> render ( ' myview.phtml ' , array ( ' title ' => ' My View ' ));

// Or just: $service->title = 'My View';

myview.phtml

 < title > < ?php echo $this- > escape($this- > title) ? > </ title >

뷰는 $service 범위에서 컴파일되고 실행되므로 $this 사용하여 모든 서비스 메서드에 액세스할 수 있습니다.

 $ this -> render ( ' partial.html ' )           // Render partials
$ this -> sharedData ()-> get ( ' myvar ' )       // Access stored service variables
echo $ this -> query ( array ( ' page ' => 2 ))   // Modify the current query string

API

다음은 여러분이 가장 많이 사용할 공통 클래스의 공개 메소드 목록입니다. 클래스/메서드 문서의 보다 공식적인 소스를 보려면 PHPdoc 생성 문서를 참조하세요.

 $ request ->
    id ( $ hash = true )                    // Get a unique ID for the request
    paramsGet()                         // Return the GET parameter collection
    paramsPost()                        // Return the POST parameter collection
    paramsNamed()                       // Return the named parameter collection
    cookies()                           // Return the cookies collection
    server()                            // Return the server collection
    headers()                           // Return the headers collection
    files()                             // Return the files collection
    body()                              // Get the request body
    params()                            // Return all parameters
    params ( $ mask = null )                // Return all parameters that match the mask array - extract() friendly
    param ( $ key , $ default = null )        // Get a request parameter (get, post, named)
    isSecure()                          // Was the request sent via HTTPS?
    ip()                                // Get the request IP
    userAgent()                         // Get the request user agent
    uri()                               // Get the request URI
    pathname()                          // Get the request pathname
    method()                            // Get the request method
    method ( $ method )                     // Check if the request method is $method, i.e. method('post') => true
    query ( $ key , $ value = null )          // Get, add to, or modify the current query string
    <param>                             // Get / Set (if assigned a value) a request parameter

$ response ->
    protocolVersion ( $ protocol_version = null )       // Get the protocol version, or set it to the passed value
    body ( $ body = null )                              // Get the response body's content, or set it to the passed value
    status()                                        // Get the response's status object
    headers()                                       // Return the headers collection
    cookies()                                       // Return the cookies collection
    code ( $ code = null )                              // Return the HTTP response code, or set it to the passed value
    prepend ( $ content )                               // Prepend a string to the response body
    append ( $ content )                                // Append a string to the response body
    isLocked()                                      // Check if the response is locked
    requireUnlocked()                               // Require that a response is unlocked
    lock()                                          // Lock the response from further modification
    unlock()                                        // Unlock the response
    sendHeaders ( $ override = false )                  // Send the HTTP response headers
    sendCookies ( $ override = false )                  // Send the HTTP response cookies
    sendBody()                                      // Send the response body's content
    send()                                          // Send the response and lock it
    isSent()                                        // Check if the response has been sent
    chunk ( $ str = null )                              // Enable response chunking (see the wiki)
    header ( $ key , $ value = null )                     // Set a response header
    cookie ( $ key , $ value = null , $ expiry = null )     // Set a cookie
    cookie ( $ key , null )                              // Remove a cookie
    noCache()                                       // Tell the browser not to cache the response
    redirect ( $ url , $ code = 302 )                     // Redirect to the specified URL
    dump ( $ obj )                                      // Dump an object
    file ( $ path , $ filename = null )                   // Send a file
    json ( $ object , $ jsonp_prefix = null )             // Send an object as JSON or JSONP by providing padding prefix

$ service ->
    sharedData()                                    // Return the shared data collection
    startSession()                                  // Start a session and return its ID
    flash( $ msg , $ type = ' info ' , $ params = array()   // Set a flash message
    flashes ( $ type = null )                           // Retrieve and clears all flashes of $type
    markdown( $ str , $ args , ...)                      // Return a string formatted with markdown
    escape ( $ str )                                    // Escape a string
    refresh()                                       // Redirect to the current URL
    back()                                          // Redirect to the referer
    query ( $ key , $ value = null )                      // Modify the current query string
    query ( $ arr )
    layout ( $ layout )                                 // Set the view layout
    yieldView ()                                     // Call inside the layout to render the view content
    render ( $ view , $ data = array ())                  // Render a view or partial (in the scope of $response)
    partial ( $ view , $ data = array ())                 // Render a partial without a layout (in the scope of $response)
    addValidator ( $ method , $ callback )                // Add a custom validator method
    validate ( $ string , $ err = null )                  // Validate a string (with a custom error message)
    validateParam ( $ param , $ err = null )                  // Validate a param
    <callback>( $ arg1 , ...)                          // Call a user-defined helper
    <property>                                      // Get a user-defined property

$ app ->
    < callback >( $ arg1 , ...)                          //Call a user-defined helper

$ validator ->
    notNull()                           // The string must not be null
    isLen ( $ length )                      // The string must be the exact length
    isLen ( $ min , $ max )                   // The string must be between $min and $max length (inclusive)
    isInt()                             // Check for a valid integer
    isFloat()                           // Check for a valid float/decimal
    isEmail()                           // Check for a valid email
    isUrl()                             // Check for a valid URL
    isIp()                              // Check for a valid IP
    isAlpha()                           // Check for a-z (case insensitive)
    isAlnum()                           // Check for alphanumeric characters
    contains ( $ needle )                   // Check if the string contains $needle
    isChars ( $ chars )                     // Validate against a character list
    isRegex ( $ pattern , $ modifiers = '' )  // Validate against a regular expression
    notRegex ( $ pattern , $ modifiers = '' )
    is<Validator>()                     // Validate against a custom validator
    not<Validator>()                    // The validator can't match
    <Validator>()                       // Alias for is<Validator>()

단위 테스트

단위 테스트는 Klein과 같은 라우팅 엔진을 개발하는 데 중요한 부분입니다. 추가된 기능이나 버그 수정은 많은 테스트 없이는 찾기 어려운 부작용을 초래할 수 있으므로 단위 테스트가 중요합니다.

이 프로젝트는 단위 테스트 프레임워크로 PHPUnit을 사용합니다.

테스트는 모두 /tests 에 있으며 각 테스트는 추상 클래스 AbstractKleinTest 확장합니다.

프로젝트를 테스트하려면 php composer.phar install --dev 실행하여 작곡가가 포함된 PHPUnit의 일반 버전을 다운로드하고 ./vendor/bin/phpunit 을 사용하여 기본 디렉터리에서 테스트를 실행하세요.

기여

자세한 내용은 기여 가이드를 참조하세요.

추가 정보

자세한 내용은 위키를 참조하세요.

기여자

트레버 N. 수아레즈

특허

(MIT 라이센스)

본 소프트웨어 및 관련 문서 파일("소프트웨어")의 사본을 취득한 모든 사람에게 사용, 복사, 수정, 병합에 대한 권리를 포함하되 이에 국한되지 않고 제한 없이 소프트웨어를 취급할 수 있는 권한이 무료로 부여됩니다. , 소프트웨어 사본을 게시, 배포, 재라이센스 부여 및/또는 판매하고, 소프트웨어를 제공받은 사람에게 다음 조건에 따라 그렇게 하도록 허용합니다.

소프트웨어는 상품성, 특정 목적에의 적합성 및 비침해에 대한 보증을 포함하되 이에 국한되지 않고 명시적이든 묵시적이든 어떠한 종류의 보증 없이 "있는 그대로" 제공됩니다. 어떠한 경우에도 작성자나 저작권 보유자는 계약, 불법 행위 또는 기타 행위로 인해 소프트웨어나 사용 또는 기타 거래와 관련하여 발생하는 모든 청구, 손해 또는 기타 책임에 대해 책임을 지지 않습니다. 소프트웨어.

확장하다