\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-code-snippets-and-tips.pdf) /Creator (Cheatography) /Author (Bhavi) /Subject (Magento 2 Useful Code Snippets and Tips 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}{000000} \definecolor{LightBackground}{HTML}{F7F7F7} \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 Code Snippets and Tips Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Bhavi} via \textcolor{DarkBackground}{\uline{cheatography.com/198595/cs/42120/}}} \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}Not Yet Published.\\ Updated 19th 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.43873 cm} x{2.53827 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Useful Tips for becoming Quality magento developer}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{Use dependency injection:}} & Inject dependencies into your classes for better testability and maintainability \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} {\bf{Follow Magento's coding standards:}} & Adhere to coding conventions for consistency and readability \tn % Row Count 7 (+ 3) % Row 2 \SetRowColor{LightBackground} {\bf{Test your code thoroughly:}} & Write unit and integration tests to ensure code quality and prevent regressions \tn % Row Count 11 (+ 4) % Row 3 \SetRowColor{white} {\bf{Use Magento's built-in features:}} & Take advantage of Magento's features like layout XML, UI components, and API endpoints before creating custom extensions \tn % Row Count 17 (+ 6) % Row 4 \SetRowColor{LightBackground} {\bf{Utilize the Magento community:}} & Engage with the active Magento community for help, support, and resources \tn % Row Count 21 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Getting the current customer session}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\$objectManager = \textbackslash{}Magento\textbackslash{}Framework\textbackslash{}App\textbackslash{}ObjectManager::getInstance(); \newline \$customerSession = \$objectManager-\textgreater{}get(\textbackslash{}Magento\textbackslash{}Customer\textbackslash{}Model\textbackslash{}Session::class); \newline \$customerId = \$customerSession-\textgreater{}getCustomerId();} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Retrieving a product by ID}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\$objectManager = \textbackslash{}Magento\textbackslash{}Framework\textbackslash{}App\textbackslash{}ObjectManager::getInstance(); \newline \$productRepository = \$objectManager-\textgreater{}get(\textbackslash{}Magento\textbackslash{}Catalog\textbackslash{}Api\textbackslash{}ProductRepositoryInterface::class); \newline \$product = \$productRepository-\textgreater{}getById(\$productId);} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Sending an email programmatically}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\$objectManager = \textbackslash{}Magento\textbackslash{}Framework\textbackslash{}App\textbackslash{}ObjectManager::getInstance(); \newline \$transportBuilder = \$objectManager-\textgreater{}get(\textbackslash{}Magento\textbackslash{}Framework\textbackslash{}Mail\textbackslash{}Template\textbackslash{}TransportBuilder::class); \newline \$transport = \$transportBuilder-\textgreater{}setTemplateIdentifier('my\_email\_template') \newline -\textgreater{}setTemplateOptions({[}'area' =\textgreater{} 'frontend', 'store' =\textgreater{} \$storeId{]}) \newline -\textgreater{}setTemplateVars({[}'data' =\textgreater{} \$myData{]}) \newline -\textgreater{}setFrom('sender@example.com') \newline -\textgreater{}addTo('recipient@example.com') \newline -\textgreater{}getTransport(); \newline \$transport-\textgreater{}sendMessage();} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Adding a custom layout block}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\textless{}referenceContainer name="content"\textgreater{} \newline \textless{}block class="Magento\textbackslash{}Framework\textbackslash{}View\textbackslash{}Element\textbackslash{}Template" name="my.custom.block" \seqsplit{template="Magento\_Theme::my-custom-block}.phtml" /\textgreater{} \newline \textless{}/referenceContainer\textgreater{}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Creating a custom UI component}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{define({[} \newline 'uiComponent' \newline {]}, function (Component) \{ \newline 'use strict'; \newline \newline return Component.extend(\{ \newline // Your component logic here \newline \}); \newline \});} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Using a custom module's configuration}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\$scopeConfig = \$objectManager-\textgreater{}get(\textbackslash{}Magento\textbackslash{}Framework\textbackslash{}App\textbackslash{}Config\textbackslash{}ScopeConfigInterface::class); \newline \$myModuleConfigValue = \$scopeConfig-\textgreater{}getValue('my/module/config/path', \textbackslash{}Magento\textbackslash{}Store\textbackslash{}Model\textbackslash{}ScopeInterface::SCOPE\_STORE);} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Logging messages for debugging}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\$logger = \$objectManager-\textgreater{}get(\textbackslash{}Psr\textbackslash{}Log\textbackslash{}LoggerInterface::class); \newline \$logger-\textgreater{}debug('My debug message'); \newline \$logger-\textgreater{}info('My info message'); \newline \$logger-\textgreater{}error('My error message');} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Creating a custom admin grid}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\textless{}listing \seqsplit{xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"} \newline xsi:noNamespaceSchemaLocation="urn:magento:module:Magento\_Ui:etc/ui\_configuration.xsd"\textgreater{} \newline \newline \textless{}/listing\textgreater{}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Creating a custom API endpoint}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{// In your module's webapi.xml \newline \textless{}route url="/V1/my-endpoint" method="GET"\textgreater{} \newline \textless{}service class="My\textbackslash{}Module\textbackslash{}Api\textbackslash{}MyEndpointInterface" method="getList"/\textgreater{} \newline \textless{}resources\textgreater{} \newline \textless{}resource ref="anonymous"/\textgreater{} \newline \textless{}/resources\textgreater{} \newline \textless{}/route\textgreater{}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}