표준 Create Page 가이드

What?

• 표준 생성는 Target 모델 record 을 추가하는것을 의미한다.
• 표준 create page 는 standard_create() 을 통해 생성된 코드 및 HTML 을 의미한다.

def standard_create(request, template_name, form_class, redirect_view, redirect_path_variables, callback,
                    **callback_kwargs):
    """
    표준 생성 폼 처리 뷰 함수입니다. 폼 처리 후 리디렉션을 수행합니다.

    :param request: HttpRequest 객체
    :param template_name: 렌더링에 사용할 템플릿 이름
    :param form_class: 사용할 폼 클래스
    :param redirect_view: 폼 처리 완료 후 이동할 뷰 이름
    :param redirect_path_variables: 리디렉션 시 전달할 추가적인 경로 변수들 (딕셔너리 형태)
    :param callback: 선택적인 콜백 함수 (함수 혹은 메서드)
    :param callback_kwargs: 콜백 함수에 전달할 추가 키워드 인자들
    :return: HttpResponse 객체
    """
    if request.method == 'POST':
        # POST 요청 처리
        form = form_class(request.POST, request.FILES)  # POST 데이터 및 파일 처리
        # 유효성 검사 통과 시
        if form.is_valid():
            valid_inst = form.save(commit=False)
            # 콜백 함수 호출
            if callback:

                callback(request=request,
                         template_name=template_name,
                         form_class=form_class,
                         redirect_view=redirect_view,
                         redirect_path_variables=redirect_path_variables,
                         valid_inst=valid_inst,
                         **callback_kwargs)
            # 데이터베이스에 저장
            valid_inst.save()

            # 리디렉션
            if redirect_path_variables:  # redirect_path_variables 이 None 이 아니면
                return redirect(redirect_view, **redirect_path_variables)
            else:
                return redirect(redirect_view)
        # 유효성 검사 실패시
        else:
            content = render(request, template_name=template_name, context={'form': form}).content.decode('utf-8')
            ret_html = add_content(request, 'doctris', content)
            return HttpResponse(ret_html)
    elif request.method == 'GET':  # GET 요청 처리
        form = form_class()  # <-- FILES 와 같이 입력이 되어야 한다.

        # 폼을 렌더링하고 추가 콘텐츠 생성
        added_contents = []
        content = render(request, template_name=template_name, context={'form': form}).content.decode('utf-8')
        added_contents.append(content)

        # 콜백 함수 호출
        if callback:
            callback(request=request,
                     template_name=template_name,
                     form_class=form_class,
                     redirect_view=redirect_view,
                     redirect_path_variables=redirect_path_variables,
                     added_contents=added_contents,
                     **callback_kwargs)
        # 최종 렌더링
        ret_html = add_content(request, 'doctris', *added_contents)
        return HttpResponse(ret_html)


속성

• CreateForm 을 활용해 Record 추가시 필요한 필드 항목을 가져온다.

• 추가가 모두 끝나면 redirect 를 통해 신호를 송신한다.

• callback 함수는 GET, POST 모두 실행된다.

  if method == 'GET' or method == 'POST' 을 통해서 작성

How to use ?

# 2번째 예제
def create(request):
    """
    프로젝트를 생성하는 뷰 함수입니다.

    :param request: HttpRequest 객체
    :return: HttpResponse 객체
    """
    def _callback(**kwargs):
        if kwargs['request'].method == 'GET':
            title = h_tag(2, '프로젝트 생성')
            kwargs['added_contents'][0] = title + card_row((kwargs['added_contents'][0], 12))

    return standard_create(request, 'standard/create.html', ProjectFileCreateForm, 'project:detail', {}, _callback)

  
# 2번째 예제
def projectfile_create(request):
  """
  프로젝트 산출물을 생성하는 뷰 함수입니다.

  :param request: HttpRequest 객체
  :return: HttpResponse 객체
  """
  def _callback(**kwargs):
      if kwargs['request'].method == 'POST':
          valid_inst = kwargs['valid_inst']
          redirect_path_variables = kwargs['redirect_path_variables']
          # 옆 코드를 실행하기 위해 필요한 코드=> redirect(project:detail, id=valid_inst.project_id)
          redirect_path_variables['id'] = valid_inst.project_id
      if kwargs['request'].method == 'GET':
          title = h_tag(2, '프로젝트 산출물 생성')
          kwargs['added_contents'][0] = title + card_row((kwargs['added_contents'][0], 12))

  return standard_create(request, 'standard/create.html', ProjectFileCreateForm, 'project:detail', {},
                         _callback)

1. standard_index 함수를 통해 구현합니다.
2. 목록을 보여주고자 하는 모델을 선택합니다.
3. 목록 필터를 설정합니다.
4. Form field 을 통해 어떤 필드를 사용자에게 보여줄지 결정합니다
5. url path 을 제공합니다.
6. design (base) 형태를 결정합니다.
7. callback function 을 제공하여 사용자가 직접 객체를 컨트롤 할수 있도록 합니다.

Callback function

위 그림과 같이 callback function 을 통해서 우리는 다양한 작업들을 수행 할 수 있습니다. 해당 function 에서의 callback function 은 딱히 정해진 목적은 없지만 대표적으로 2가지 목적을 가지고 수행합니다.

1. POST 일 때, 생성된 instance 을 활용해 작업을 할때 사용됩니다.

2. POST 일 때, redirect 시 필요한 키워드인자를 추가할때 사용합니다.

3. GET 일 때, content design 을 입히거나 html 을 추가하는 작업들을 수행합니다.

   1. 제목 을 추가하는 작업들을 수행합니다.

      title = h_tag(2, '프로젝트 목록')
      

   2. 위 예제에서는 curd_table_html 에 div class=card 에 curd_table_html 을 삽입하는 작업들을 수행합니다.

      added_contents = kwargs['added_contents']
      added_contents[0] = title + card_row((added_contents[0], 12)
      

⚠️ 추가적으로 added_contents 에 추가된 자료는 순서대로 화면에 랜더링 됩니다.