\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{Bhavi} \pdfinfo{ /Title (magento-2-useful-methods.pdf) /Creator (Cheatography) /Author (Bhavi) /Subject (Magento 2 Useful Methods Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{A38146} \definecolor{LightBackground}{HTML}{F9F7F3} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Magento 2 Useful Methods Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Bhavi} via \textcolor{DarkBackground}{\uline{cheatography.com/198595/cs/42038/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}Bhavi \\ \uline{cheatography.com/bhavi} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 19th January, 2024.\\ Updated 23rd January, 2024.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{3} \begin{tabularx}{5.377cm}{x{2.88666 cm} x{2.09034 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Module Structure}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{app/code/VendorName/ModuleName}} & Basic module structure \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} {\bf{registration.php}} & Module registration file \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} {\bf{etc/module.xml}} & Module configuration file \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} {\bf{etc/frontend/routes.xml}} & Define frontend routes \tn % Row Count 8 (+ 2) % Row 4 \SetRowColor{LightBackground} {\bf{etc/adminhtml/routes.xml}} & Define admin routes \tn % Row Count 10 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{1.59264 cm} x{3.38436 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Controller Actions}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{execute()}} & Main controller action method \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} {\bf{ResultInterface}} & Various result types (Json, Redirect, Page, etc.) \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} {\bf{getRequest()}} & Retrieve request object \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} {\bf{getResponse()}} & Retrieve response object \tn % Row Count 8 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{2.73735 cm} x{2.23965 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Plugins}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{di.xml}} & Define plugin configurations \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} {\bf{beforeMethod(), aroundMethod(), afterMethod():}} & Plugin methods \tn % Row Count 5 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{proceed()}} & Call the next method in the chain \tn % Row Count 7 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{2.4885 cm} x{2.4885 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Magento CLI Commands}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{bin/magento module:enable Vendor\_Module}} & Enable a module \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} {\bf{bin/magento setup:upgrade}} & Apply database schema and data changes \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} {\bf{bin/magento cache:flush}} & Flushes cache including 3rd party modules \tn % Row Count 8 (+ 3) % Row 3 \SetRowColor{white} {\bf{bin/magento cache:clean}} & Cleans Magento cache \tn % Row Count 10 (+ 2) % Row 4 \SetRowColor{LightBackground} {\bf{bin/magento indexer:reindex}} & Reindex Data \tn % Row Count 12 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{2.33919 cm} x{2.63781 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Models}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{load(), save(), delete()}} & Basic CRUD operations \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} {\bf{\_\_construct()}} & Constructor method \tn % Row Count 3 (+ 1) % Row 2 \SetRowColor{LightBackground} {\bf{getData(), setData()}} & Get and set model data \tn % Row Count 5 (+ 2) % Row 3 \SetRowColor{white} {\bf{getResource()}} & Retrieve model's resource model \tn % Row Count 7 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{2.58804 cm} x{2.38896 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Layout XML}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{\textless{}referenceContainer\textgreater{}, \textless{}referenceBlock\textgreater{}}} & Reference existing containers/blocks. \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} {\bf{\textless{}block class="" template=""\textgreater{}}} & Difine a block \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} {\bf{\textless{}arguments\textgreater{}}} & Pass arguments to blocks \tn % Row Count 7 (+ 2) % Row 3 \SetRowColor{white} {\bf{\textless{}update handle=""\textgreater{}}} & Apply layout updates. \tn % Row Count 9 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{3.23505 cm} x{1.74195 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Observers}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{events.xml}} & Define observer events \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} {\bf{execute(\textbackslash{}Magento\textbackslash{}Framework\textbackslash{}Event\textbackslash{}Observer \$observer)}} & Observer method. \tn % Row Count 5 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{getEvent()}} & getEvent() \tn % Row Count 6 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{3.03597 cm} x{1.94103 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Templates}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{\textless{}?php echo \$block-\textgreater{}escapeHtml(\_\_("Text")); ?\textgreater{}}} & Output escaped text \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} {\bf{\textless{}?php echo \$block-\textgreater{}getUrl('route/controller/action'); ?\textgreater{}}} & Generate URL \tn % Row Count 6 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{\textless{}?php echo \$block-\textgreater{}getChildHtml(); ?\textgreater{}}} & Output child block content \tn % Row Count 8 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}